nextcloud / server

lib/private/Files/Storage/Local.php

Indentation +534 added lines, -534 removed lines

@@ -56,538 +56,538 @@
  * for local filestore, we only have to map the paths
  */
 class Local extends \OC\Files\Storage\Common {
-	protected $datadir;
-
-	protected $dataDirLength;
-
-	protected $realDataDir;
-
-	private IConfig $config;
-
-	private IMimeTypeDetector $mimeTypeDetector;
-
-	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);
-		$this->config = \OC::$server->get(IConfig::class);
-		$this->mimeTypeDetector = \OC::$server->get(IMimeTypeDetector::class);
-	}
-
-	public function __destruct() {
-	}
-
-	public function getId() {
-		return 'local::' . $this->datadir;
-	}
-
-	public function mkdir($path) {
-		$sourcePath = $this->getSourcePath($path);
-		$oldMask = umask(022);
-		$result = @mkdir($sourcePath, 0777, true);
-		umask($oldMask);
-		return $result;
-	}
-
-	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();
-				clearstatcache(true, $this->getSourcePath($file));
-				if (in_array($file->getBasename(), ['.', '..'])) {
-					$it->next();
-					continue;
-				} elseif ($file->isDir()) {
-					rmdir($file->getPathname());
-				} elseif ($file->isFile() || $file->isLink()) {
-					unlink($file->getPathname());
-				}
-				$it->next();
-			}
-			clearstatcache(true, $this->getSourcePath($path));
-			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) {
-		$fullPath = $this->getSourcePath($path);
-		clearstatcache(true, $fullPath);
-		$statResult = @stat($fullPath);
-		if (PHP_INT_SIZE === 4 && $statResult && !$this->is_dir($path)) {
-			$filesize = $this->filesize($path);
-			$statResult['size'] = $filesize;
-			$statResult[7] = $filesize;
-		}
-		if (is_array($statResult)) {
-			$statResult['full_path'] = $fullPath;
-		}
-		return $statResult;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getMetaData($path) {
-		$stat = $this->stat($path);
-		if (!$stat) {
-			return null;
-		}
-
-		$permissions = Constants::PERMISSION_SHARE;
-		$statPermissions = $stat['mode'];
-		$isDir = ($statPermissions & 0x4000) === 0x4000 && !($statPermissions & 0x8000);
-		if ($statPermissions & 0x0100) {
-			$permissions += Constants::PERMISSION_READ;
-		}
-		if ($statPermissions & 0x0080) {
-			$permissions += Constants::PERMISSION_UPDATE;
-			if ($isDir) {
-				$permissions += Constants::PERMISSION_CREATE;
-			}
-		}
-
-		if (!($path === '' || $path === '/')) { // deletable depends on the parents unix permissions
-			$parent = dirname($stat['full_path']);
-			if (is_writable($parent)) {
-				$permissions += Constants::PERMISSION_DELETE;
-			}
-		}
-
-		$data = [];
-		$data['mimetype'] = $isDir ? 'httpd/unix-directory' : $this->mimeTypeDetector->detectPath($path);
-		$data['mtime'] = $stat['mtime'];
-		if ($data['mtime'] === false) {
-			$data['mtime'] = time();
-		}
-		if ($isDir) {
-			$data['size'] = -1; //unknown
-		} else {
-			$data['size'] = $stat['size'];
-		}
-		$data['etag'] = $this->calculateEtag($path, $stat);
-		$data['storage_mtime'] = $data['mtime'];
-		$data['permissions'] = $permissions;
-		$data['name'] = basename($path);
-
-		return $data;
-	}
-
-	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_file($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;
-		}
-		$oldMask = umask(022);
-		if (!is_null($mtime)) {
-			$result = @touch($this->getSourcePath($path), $mtime);
-		} else {
-			$result = @touch($this->getSourcePath($path));
-		}
-		umask($oldMask);
-		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) {
-		$oldMask = umask(022);
-		$result = file_put_contents($this->getSourcePath($path), $data);
-		umask($oldMask);
-		return $result;
-	}
-
-	public function unlink($path) {
-		if ($this->is_dir($path)) {
-			return $this->rmdir($path);
-		} elseif ($this->is_file($path)) {
-			return unlink($this->getSourcePath($path));
-		} else {
-			return false;
-		}
-	}
-
-	private function checkTreeForForbiddenItems(string $path) {
-		$iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($path));
-		foreach ($iterator as $file) {
-			/** @var \SplFileInfo $file */
-			if (Filesystem::isFileBlacklisted($file->getBasename())) {
-				throw new ForbiddenException('Invalid path: ' . $file->getPathname(), 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);
-		} elseif ($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;
-			}
-
-			$this->checkTreeForForbiddenItems($this->getSourcePath($path1));
-		}
-
-		return rename($this->getSourcePath($path1), $this->getSourcePath($path2));
-	}
-
-	public function copy($path1, $path2) {
-		if ($this->is_dir($path1)) {
-			return parent::copy($path1, $path2);
-		} else {
-			$oldMask = umask(022);
-			$result = copy($this->getSourcePath($path1), $this->getSourcePath($path2));
-			umask($oldMask);
-			return $result;
-		}
-	}
-
-	public function fopen($path, $mode) {
-		$oldMask = umask(022);
-		$result = fopen($this->getSourcePath($path), $mode);
-		umask($oldMask);
-		return $result;
-	}
-
-	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 = function_exists('disk_free_space') ? disk_free_space($sourcePath) : false;
-		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: ' . $path, false);
-		}
-
-		$fullPath = $this->datadir . $path;
-		$currentPath = $path;
-		$allowSymlinks = $this->config->getSystemValue('localstorage.allowsymlinks', false);
-		if ($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) {
-		return $this->calculateEtag($path, $this->stat($path));
-	}
-
-	private function calculateEtag(string $path, array $stat): string {
-		if ($stat['mode'] & 0x4000 && !($stat['mode'] & 0x8000)) { // is_dir & not socket
-			return parent::getETag($path);
-		} else {
-			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);
-		}
-	}
-
-	/**
-	 * @param IStorage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @param bool $preserveMtime
-	 * @return bool
-	 */
-	public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = false) {
-		// Don't treat ACLStorageWrapper like local storage where copy can be done directly.
-		// Instead use the slower recursive copying in php from Common::copyFromStorage with
-		// more permissions checks.
-		if ($sourceStorage->instanceOfStorage(Local::class) && !$sourceStorage->instanceOfStorage('OCA\GroupFolders\ACL\ACLStorageWrapper')) {
-			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 {
-		$result = $this->file_put_contents($path, $stream);
-		if (is_resource($stream)) {
-			fclose($stream);
-		}
-		if ($result === false) {
-			throw new GenericFileException("Failed write stream to $path");
-		} else {
-			return $result;
-		}
-	}
+    protected $datadir;
+
+    protected $dataDirLength;
+
+    protected $realDataDir;
+
+    private IConfig $config;
+
+    private IMimeTypeDetector $mimeTypeDetector;
+
+    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);
+        $this->config = \OC::$server->get(IConfig::class);
+        $this->mimeTypeDetector = \OC::$server->get(IMimeTypeDetector::class);
+    }
+
+    public function __destruct() {
+    }
+
+    public function getId() {
+        return 'local::' . $this->datadir;
+    }
+
+    public function mkdir($path) {
+        $sourcePath = $this->getSourcePath($path);
+        $oldMask = umask(022);
+        $result = @mkdir($sourcePath, 0777, true);
+        umask($oldMask);
+        return $result;
+    }
+
+    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();
+                clearstatcache(true, $this->getSourcePath($file));
+                if (in_array($file->getBasename(), ['.', '..'])) {
+                    $it->next();
+                    continue;
+                } elseif ($file->isDir()) {
+                    rmdir($file->getPathname());
+                } elseif ($file->isFile() || $file->isLink()) {
+                    unlink($file->getPathname());
+                }
+                $it->next();
+            }
+            clearstatcache(true, $this->getSourcePath($path));
+            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) {
+        $fullPath = $this->getSourcePath($path);
+        clearstatcache(true, $fullPath);
+        $statResult = @stat($fullPath);
+        if (PHP_INT_SIZE === 4 && $statResult && !$this->is_dir($path)) {
+            $filesize = $this->filesize($path);
+            $statResult['size'] = $filesize;
+            $statResult[7] = $filesize;
+        }
+        if (is_array($statResult)) {
+            $statResult['full_path'] = $fullPath;
+        }
+        return $statResult;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getMetaData($path) {
+        $stat = $this->stat($path);
+        if (!$stat) {
+            return null;
+        }
+
+        $permissions = Constants::PERMISSION_SHARE;
+        $statPermissions = $stat['mode'];
+        $isDir = ($statPermissions & 0x4000) === 0x4000 && !($statPermissions & 0x8000);
+        if ($statPermissions & 0x0100) {
+            $permissions += Constants::PERMISSION_READ;
+        }
+        if ($statPermissions & 0x0080) {
+            $permissions += Constants::PERMISSION_UPDATE;
+            if ($isDir) {
+                $permissions += Constants::PERMISSION_CREATE;
+            }
+        }
+
+        if (!($path === '' || $path === '/')) { // deletable depends on the parents unix permissions
+            $parent = dirname($stat['full_path']);
+            if (is_writable($parent)) {
+                $permissions += Constants::PERMISSION_DELETE;
+            }
+        }
+
+        $data = [];
+        $data['mimetype'] = $isDir ? 'httpd/unix-directory' : $this->mimeTypeDetector->detectPath($path);
+        $data['mtime'] = $stat['mtime'];
+        if ($data['mtime'] === false) {
+            $data['mtime'] = time();
+        }
+        if ($isDir) {
+            $data['size'] = -1; //unknown
+        } else {
+            $data['size'] = $stat['size'];
+        }
+        $data['etag'] = $this->calculateEtag($path, $stat);
+        $data['storage_mtime'] = $data['mtime'];
+        $data['permissions'] = $permissions;
+        $data['name'] = basename($path);
+
+        return $data;
+    }
+
+    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_file($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;
+        }
+        $oldMask = umask(022);
+        if (!is_null($mtime)) {
+            $result = @touch($this->getSourcePath($path), $mtime);
+        } else {
+            $result = @touch($this->getSourcePath($path));
+        }
+        umask($oldMask);
+        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) {
+        $oldMask = umask(022);
+        $result = file_put_contents($this->getSourcePath($path), $data);
+        umask($oldMask);
+        return $result;
+    }
+
+    public function unlink($path) {
+        if ($this->is_dir($path)) {
+            return $this->rmdir($path);
+        } elseif ($this->is_file($path)) {
+            return unlink($this->getSourcePath($path));
+        } else {
+            return false;
+        }
+    }
+
+    private function checkTreeForForbiddenItems(string $path) {
+        $iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($path));
+        foreach ($iterator as $file) {
+            /** @var \SplFileInfo $file */
+            if (Filesystem::isFileBlacklisted($file->getBasename())) {
+                throw new ForbiddenException('Invalid path: ' . $file->getPathname(), 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);
+        } elseif ($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;
+            }
+
+            $this->checkTreeForForbiddenItems($this->getSourcePath($path1));
+        }
+
+        return rename($this->getSourcePath($path1), $this->getSourcePath($path2));
+    }
+
+    public function copy($path1, $path2) {
+        if ($this->is_dir($path1)) {
+            return parent::copy($path1, $path2);
+        } else {
+            $oldMask = umask(022);
+            $result = copy($this->getSourcePath($path1), $this->getSourcePath($path2));
+            umask($oldMask);
+            return $result;
+        }
+    }
+
+    public function fopen($path, $mode) {
+        $oldMask = umask(022);
+        $result = fopen($this->getSourcePath($path), $mode);
+        umask($oldMask);
+        return $result;
+    }
+
+    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 = function_exists('disk_free_space') ? disk_free_space($sourcePath) : false;
+        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: ' . $path, false);
+        }
+
+        $fullPath = $this->datadir . $path;
+        $currentPath = $path;
+        $allowSymlinks = $this->config->getSystemValue('localstorage.allowsymlinks', false);
+        if ($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) {
+        return $this->calculateEtag($path, $this->stat($path));
+    }
+
+    private function calculateEtag(string $path, array $stat): string {
+        if ($stat['mode'] & 0x4000 && !($stat['mode'] & 0x8000)) { // is_dir & not socket
+            return parent::getETag($path);
+        } else {
+            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);
+        }
+    }
+
+    /**
+     * @param IStorage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @param bool $preserveMtime
+     * @return bool
+     */
+    public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = false) {
+        // Don't treat ACLStorageWrapper like local storage where copy can be done directly.
+        // Instead use the slower recursive copying in php from Common::copyFromStorage with
+        // more permissions checks.
+        if ($sourceStorage->instanceOfStorage(Local::class) && !$sourceStorage->instanceOfStorage('OCA\GroupFolders\ACL\ACLStorageWrapper')) {
+            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 {
+        $result = $this->file_put_contents($path, $stream);
+        if (is_resource($stream)) {
+            fclose($stream);
+        }
+        if ($result === false) {
+            throw new GenericFileException("Failed write stream to $path");
+        } else {
+            return $result;
+        }
+    }
 }

Spacing +13 added lines, -13 removed lines

@@ -76,7 +76,7 @@ 
 			$this->realDataDir = $this->datadir;
 		} else {
 			$realPath = realpath($this->datadir) ?: $this->datadir;
-			$this->realDataDir = rtrim($realPath, '/') . '/';
+			$this->realDataDir = rtrim($realPath, '/').'/';
 		}
 		if (substr($this->datadir, -1) !== '/') {
 			$this->datadir .= '/';
@@ -90,7 +90,7 @@ 
 	}
 
 	public function getId() {
-		return 'local::' . $this->datadir;
+		return 'local::'.$this->datadir;
 	}
 
 	public function mkdir($path) {
@@ -309,7 +309,7 @@ 
 		foreach ($iterator as $file) {
 			/** @var \SplFileInfo $file */
 			if (Filesystem::isFileBlacklisted($file->getBasename())) {
-				throw new ForbiddenException('Invalid path: ' . $file->getPathname(), false);
+				throw new ForbiddenException('Invalid path: '.$file->getPathname(), false);
 			}
 		}
 	}
@@ -319,17 +319,17 @@ 
 		$dstParent = dirname($path2);
 
 		if (!$this->isUpdatable($srcParent)) {
-			\OCP\Util::writeLog('core', 'unable to rename, source directory is not writable : ' . $srcParent, ILogger::ERROR);
+			\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);
+			\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);
+			\OCP\Util::writeLog('core', 'unable to rename, file does not exists : '.$path1, ILogger::ERROR);
 			return false;
 		}
 
@@ -419,13 +419,13 @@ 
 			if (\OC\Files\Filesystem::isIgnoredDir($item)) {
 				continue;
 			}
-			$physicalItem = $physicalDir . '/' . $item;
+			$physicalItem = $physicalDir.'/'.$item;
 
 			if (strstr(strtolower($item), strtolower($query)) !== false) {
-				$files[] = $dir . '/' . $item;
+				$files[] = $dir.'/'.$item;
 			}
 			if (is_dir($physicalItem)) {
-				$files = array_merge($files, $this->searchInDir($query, $dir . '/' . $item));
+				$files = array_merge($files, $this->searchInDir($query, $dir.'/'.$item));
 			}
 		}
 		return $files;
@@ -455,10 +455,10 @@ 
 	 */
 	public function getSourcePath($path) {
 		if (Filesystem::isFileBlacklisted($path)) {
-			throw new ForbiddenException('Invalid path: ' . $path, false);
+			throw new ForbiddenException('Invalid path: '.$path, false);
 		}
 
-		$fullPath = $this->datadir . $path;
+		$fullPath = $this->datadir.$path;
 		$currentPath = $path;
 		$allowSymlinks = $this->config->getSystemValue('localstorage.allowsymlinks', false);
 		if ($allowSymlinks || $currentPath === '') {
@@ -471,10 +471,10 @@ 
 			if ($currentPath === '' || $currentPath === '.') {
 				return $fullPath;
 			}
-			$realPath = realpath($this->datadir . $currentPath);
+			$realPath = realpath($this->datadir.$currentPath);
 		}
 		if ($realPath) {
-			$realPath = $realPath . '/';
+			$realPath = $realPath.'/';
 		}
 		if (substr($realPath, 0, $this->dataDirLength) === $this->realDataDir) {
 			return $fullPath;

lib/private/Files/Storage/Common.php

Indentation +814 added lines, -814 removed lines

@@ -77,822 +77,822 @@
  * in classes which extend it, e.g. $this->stat() .
  */
 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);
-		} elseif ($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 $this->isUpdatable($path);
-		}
-		$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');
-			[, $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
-	 * Nextcloud 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);
-			} elseif ($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()->warning("External storage not available: " . $e->getMessage());
-			\OC::$server->getLogger()->logException($e, ['level' => ILogger::WARN]);
-			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);
+        } elseif ($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 $this->isUpdatable($path);
+        }
+        $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');
+            [, $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
+     * Nextcloud 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);
+            } elseif ($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()->warning("External storage not available: " . $e->getMessage());
+            \OC::$server->getLogger()->logException($e, ['level' => ILogger::WARN]);
+            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) {
-		$this->scanForInvalidCharacters($fileName, "\\/");
-		$fileName = trim($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)) {
-				$result = true;
-				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');
-			$result = false;
-			if ($source) {
-				try {
-					$this->writeStream($targetInternalPath, $source);
-					$result = true;
-				} catch (\Exception $e) {
-					\OC::$server->getLogger()->logException($e, ['level' => ILogger::WARN, 'message' => 'Failed to copy stream to storage']);
-				}
-			}
-
-			if ($result && $preserveMtime) {
-				$mtime = $sourceStorage->filemtime($sourceInternalPath);
-				$this->touch($targetInternalPath, is_int($mtime) ? $mtime : null);
-			}
-
-			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 = $result && $sourceStorage->rmdir($sourceInternalPath);
-			} else {
-				$result = $result && $sourceStorage->unlink($sourceInternalPath);
-			}
-		}
-		return $result;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getMetaData($path) {
-		if (Filesystem::isFileBlacklisted($path)) {
-			throw new ForbiddenException('Invalid path: ' . $path, false);
-		}
-
-		$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;
-		$data['name'] = basename($path);
-
-		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, $this->getId() . '::' . $path);
-		} 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) {
-			throw new GenericFileException("Failed to open $path for writing");
-		}
-		try {
-			[$count, $result] = \OC_Helper::streamCopy($stream, $target);
-			if (!$result) {
-				throw new GenericFileException("Failed to copy stream");
-			}
-		} finally {
-			fclose($target);
-			fclose($stream);
-		}
-		return $count;
-	}
-
-	public function getDirectoryContent($directory): \Traversable {
-		$dh = $this->opendir($directory);
-		if (is_resource($dh)) {
-			$basePath = rtrim($directory, '/');
-			while (($file = readdir($dh)) !== false) {
-				if (!Filesystem::isIgnoredDir($file)) {
-					$childPath = $basePath . '/' . trim($file, '/');
-					$metadata = $this->getMetaData($childPath);
-					if ($metadata !== null) {
-						yield $metadata;
-					}
-				}
-			}
-		}
-	}
+                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) {
+        $this->scanForInvalidCharacters($fileName, "\\/");
+        $fileName = trim($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)) {
+                $result = true;
+                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');
+            $result = false;
+            if ($source) {
+                try {
+                    $this->writeStream($targetInternalPath, $source);
+                    $result = true;
+                } catch (\Exception $e) {
+                    \OC::$server->getLogger()->logException($e, ['level' => ILogger::WARN, 'message' => 'Failed to copy stream to storage']);
+                }
+            }
+
+            if ($result && $preserveMtime) {
+                $mtime = $sourceStorage->filemtime($sourceInternalPath);
+                $this->touch($targetInternalPath, is_int($mtime) ? $mtime : null);
+            }
+
+            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 = $result && $sourceStorage->rmdir($sourceInternalPath);
+            } else {
+                $result = $result && $sourceStorage->unlink($sourceInternalPath);
+            }
+        }
+        return $result;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getMetaData($path) {
+        if (Filesystem::isFileBlacklisted($path)) {
+            throw new ForbiddenException('Invalid path: ' . $path, false);
+        }
+
+        $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;
+        $data['name'] = basename($path);
+
+        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, $this->getId() . '::' . $path);
+        } 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) {
+            throw new GenericFileException("Failed to open $path for writing");
+        }
+        try {
+            [$count, $result] = \OC_Helper::streamCopy($stream, $target);
+            if (!$result) {
+                throw new GenericFileException("Failed to copy stream");
+            }
+        } finally {
+            fclose($target);
+            fclose($stream);
+        }
+        return $count;
+    }
+
+    public function getDirectoryContent($directory): \Traversable {
+        $dh = $this->opendir($directory);
+        if (is_resource($dh)) {
+            $basePath = rtrim($directory, '/');
+            while (($file = readdir($dh)) !== false) {
+                if (!Filesystem::isIgnoredDir($file)) {
+                    $childPath = $basePath . '/' . trim($file, '/');
+                    $metadata = $this->getMetaData($childPath);
+                    if ($metadata !== null) {
+                        yield $metadata;
+                    }
+                }
+            }
+        }
+    }
 }

Spacing +20 added lines, -20 removed lines

@@ -225,7 +225,7 @@ 
 			$this->mkdir($path2);
 			while ($file = readdir($dir)) {
 				if (!Filesystem::isIgnoredDir($file)) {
-					if (!$this->copy($path1 . '/' . $file, $path2 . '/' . $file)) {
+					if (!$this->copy($path1.'/'.$file, $path2.'/'.$file)) {
 						return false;
 					}
 				}
@@ -279,12 +279,12 @@ 
 		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);
+					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);
+						$tmp = $this->toTmpFile($path.'/'.$file);
+						rename($tmp, $target.'/'.$file);
 					}
 				}
 			}
@@ -305,10 +305,10 @@ 
 					continue;
 				}
 				if (strstr(strtolower($item), strtolower($query)) !== false) {
-					$files[] = $dir . '/' . $item;
+					$files[] = $dir.'/'.$item;
 				}
-				if ($this->is_dir($dir . '/' . $item)) {
-					$files = array_merge($files, $this->searchInDir($query, $dir . '/' . $item));
+				if ($this->is_dir($dir.'/'.$item)) {
+					$files = array_merge($files, $this->searchInDir($query, $dir.'/'.$item));
 				}
 			}
 		}
@@ -359,7 +359,7 @@ 
 		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));
+			$this->watcher->setPolicy((int) $this->getMountOption('filesystem_check_changes', $globalPolicy));
 		}
 		return $this->watcher;
 	}
@@ -376,7 +376,7 @@ 
 		}
 		if (!isset($storage->propagator)) {
 			$config = \OC::$server->getSystemConfig();
-			$storage->propagator = new Propagator($storage, \OC::$server->getDatabaseConnection(), ['appdata_' . $config->getValue('instanceid')]);
+			$storage->propagator = new Propagator($storage, \OC::$server->getDatabaseConnection(), ['appdata_'.$config->getValue('instanceid')]);
 		}
 		return $storage->propagator;
 	}
@@ -434,7 +434,7 @@ 
 	 */
 	public function cleanPath($path) {
 		if (strlen($path) == 0 or $path[0] != '/') {
-			$path = '/' . $path;
+			$path = '/'.$path;
 		}
 
 		$output = [];
@@ -462,7 +462,7 @@ 
 			\OC::$server->getLogger()->info("External storage not available: stat() failed");
 			return false;
 		} catch (\Exception $e) {
-			\OC::$server->getLogger()->warning("External storage not available: " . $e->getMessage());
+			\OC::$server->getLogger()->warning("External storage not available: ".$e->getMessage());
 			\OC::$server->getLogger()->logException($e, ['level' => ILogger::WARN]);
 			return false;
 		}
@@ -616,7 +616,7 @@ 
 				$result = true;
 				while ($result and ($file = readdir($dh)) !== false) {
 					if (!Filesystem::isIgnoredDir($file)) {
-						$result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath . '/' . $file, $targetInternalPath . '/' . $file);
+						$result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath.'/'.$file, $targetInternalPath.'/'.$file);
 					}
 				}
 			}
@@ -644,7 +644,7 @@ 
 				$this->getCache()->remove($targetInternalPath);
 			}
 		}
-		return (bool)$result;
+		return (bool) $result;
 	}
 
 	/**
@@ -704,7 +704,7 @@ 
 	 */
 	public function getMetaData($path) {
 		if (Filesystem::isFileBlacklisted($path)) {
-			throw new ForbiddenException('Invalid path: ' . $path, false);
+			throw new ForbiddenException('Invalid path: '.$path, false);
 		}
 
 		$permissions = $this->getPermissions($path);
@@ -755,7 +755,7 @@ 
 			);
 		}
 		try {
-			$provider->acquireLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type, $this->getId() . '::' . $path);
+			$provider->acquireLock('files/'.md5($this->getId().'::'.trim($path, '/')), $type, $this->getId().'::'.$path);
 		} catch (LockedException $e) {
 			if ($logger) {
 				$logger->logException($e, ['level' => ILogger::INFO]);
@@ -787,7 +787,7 @@ 
 			);
 		}
 		try {
-			$provider->releaseLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type);
+			$provider->releaseLock('files/'.md5($this->getId().'::'.trim($path, '/')), $type);
 		} catch (LockedException $e) {
 			if ($logger) {
 				$logger->logException($e, ['level' => ILogger::INFO]);
@@ -819,7 +819,7 @@ 
 			);
 		}
 		try {
-			$provider->changeLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type);
+			$provider->changeLock('files/'.md5($this->getId().'::'.trim($path, '/')), $type);
 		} catch (LockedException $e) {
 			\OC::$server->getLogger()->logException($e, ['level' => ILogger::INFO]);
 			throw $e;
@@ -886,7 +886,7 @@ 
 			$basePath = rtrim($directory, '/');
 			while (($file = readdir($dh)) !== false) {
 				if (!Filesystem::isIgnoredDir($file)) {
-					$childPath = $basePath . '/' . trim($file, '/');
+					$childPath = $basePath.'/'.trim($file, '/');
 					$metadata = $this->getMetaData($childPath);
 					if ($metadata !== null) {
 						yield $metadata;

lib/private/Files/Filesystem.php

Indentation +746 added lines, -746 removed lines

@@ -49,750 +49,750 @@
 
 class Filesystem {
 
-	/**
-	 * @var Mount\Manager $mounts
-	 */
-	private static $mounts;
-
-	public static $loaded = false;
-	/**
-	 * @var \OC\Files\View $defaultInstance
-	 */
-	private static $defaultInstance;
-
-	private static $usersSetup = [];
-
-	private static $normalizedPathCache = null;
-
-	private static $listeningForProviders = false;
-
-	/** @var string[]|null */
-	private static $blacklist = null;
-
-	/**
-	 * classname which used for hooks handling
-	 * used as signalclass in OC_Hooks::emit()
-	 */
-	public const CLASSNAME = 'OC_Filesystem';
-
-	/**
-	 * signalname emitted before file renaming
-	 *
-	 * @param string $oldpath
-	 * @param string $newpath
-	 */
-	public const signal_rename = 'rename';
-
-	/**
-	 * signal emitted after file renaming
-	 *
-	 * @param string $oldpath
-	 * @param string $newpath
-	 */
-	public const signal_post_rename = 'post_rename';
-
-	/**
-	 * signal emitted before file/dir creation
-	 *
-	 * @param string $path
-	 * @param bool $run changing this flag to false in hook handler will cancel event
-	 */
-	public const signal_create = 'create';
-
-	/**
-	 * signal emitted after file/dir creation
-	 *
-	 * @param string $path
-	 * @param bool $run changing this flag to false in hook handler will cancel event
-	 */
-	public const signal_post_create = 'post_create';
-
-	/**
-	 * signal emits before file/dir copy
-	 *
-	 * @param string $oldpath
-	 * @param string $newpath
-	 * @param bool $run changing this flag to false in hook handler will cancel event
-	 */
-	public const signal_copy = 'copy';
-
-	/**
-	 * signal emits after file/dir copy
-	 *
-	 * @param string $oldpath
-	 * @param string $newpath
-	 */
-	public const signal_post_copy = 'post_copy';
-
-	/**
-	 * signal emits before file/dir save
-	 *
-	 * @param string $path
-	 * @param bool $run changing this flag to false in hook handler will cancel event
-	 */
-	public const signal_write = 'write';
-
-	/**
-	 * signal emits after file/dir save
-	 *
-	 * @param string $path
-	 */
-	public const signal_post_write = 'post_write';
-
-	/**
-	 * signal emitted before file/dir update
-	 *
-	 * @param string $path
-	 * @param bool $run changing this flag to false in hook handler will cancel event
-	 */
-	public const signal_update = 'update';
-
-	/**
-	 * signal emitted after file/dir update
-	 *
-	 * @param string $path
-	 * @param bool $run changing this flag to false in hook handler will cancel event
-	 */
-	public const signal_post_update = 'post_update';
-
-	/**
-	 * signal emits when reading file/dir
-	 *
-	 * @param string $path
-	 */
-	public const signal_read = 'read';
-
-	/**
-	 * signal emits when removing file/dir
-	 *
-	 * @param string $path
-	 */
-	public const signal_delete = 'delete';
-
-	/**
-	 * parameters definitions for signals
-	 */
-	public const signal_param_path = 'path';
-	public const signal_param_oldpath = 'oldpath';
-	public const signal_param_newpath = 'newpath';
-
-	/**
-	 * run - changing this flag to false in hook handler will cancel event
-	 */
-	public const signal_param_run = 'run';
-
-	public const signal_create_mount = 'create_mount';
-	public const signal_delete_mount = 'delete_mount';
-	public const signal_param_mount_type = 'mounttype';
-	public const signal_param_users = 'users';
-
-	/**
-	 * @var \OC\Files\Storage\StorageFactory $loader
-	 */
-	private static $loader;
-
-	/** @var bool */
-	private static $logWarningWhenAddingStorageWrapper = true;
-
-	/**
-	 * @param bool $shouldLog
-	 * @return bool previous value
-	 * @internal
-	 */
-	public static function logWarningWhenAddingStorageWrapper($shouldLog) {
-		$previousValue = self::$logWarningWhenAddingStorageWrapper;
-		self::$logWarningWhenAddingStorageWrapper = (bool) $shouldLog;
-		return $previousValue;
-	}
-
-	/**
-	 * @param string $wrapperName
-	 * @param callable $wrapper
-	 * @param int $priority
-	 */
-	public static function addStorageWrapper($wrapperName, $wrapper, $priority = 50) {
-		if (self::$logWarningWhenAddingStorageWrapper) {
-			\OC::$server->getLogger()->warning("Storage wrapper '{wrapper}' was not registered via the 'OC_Filesystem - preSetup' hook which could cause potential problems.", [
-				'wrapper' => $wrapperName,
-				'app' => 'filesystem',
-			]);
-		}
-
-		$mounts = self::getMountManager()->getAll();
-		if (!self::getLoader()->addStorageWrapper($wrapperName, $wrapper, $priority, $mounts)) {
-			// do not re-wrap if storage with this name already existed
-			return;
-		}
-	}
-
-	/**
-	 * Returns the storage factory
-	 *
-	 * @return IStorageFactory
-	 */
-	public static function getLoader() {
-		if (!self::$loader) {
-			self::$loader = \OC::$server->query(IStorageFactory::class);
-		}
-		return self::$loader;
-	}
-
-	/**
-	 * Returns the mount manager
-	 *
-	 * @return \OC\Files\Mount\Manager
-	 */
-	public static function getMountManager($user = '') {
-		self::initMountManager();
-		return self::$mounts;
-	}
-
-	/**
-	 * get the mountpoint of the storage object for a path
-	 * ( note: because a storage is not always mounted inside the fakeroot, the
-	 * returned mountpoint is relative to the absolute root of the filesystem
-	 * and doesn't take the chroot into account )
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public static function getMountPoint($path) {
-		if (!self::$mounts) {
-			\OC_Util::setupFS();
-		}
-		$mount = self::$mounts->find($path);
-		return $mount->getMountPoint();
-	}
-
-	/**
-	 * get a list of all mount points in a directory
-	 *
-	 * @param string $path
-	 * @return string[]
-	 */
-	public static function getMountPoints($path) {
-		if (!self::$mounts) {
-			\OC_Util::setupFS();
-		}
-		$result = [];
-		$mounts = self::$mounts->findIn($path);
-		foreach ($mounts as $mount) {
-			$result[] = $mount->getMountPoint();
-		}
-		return $result;
-	}
-
-	/**
-	 * get the storage mounted at $mountPoint
-	 *
-	 * @param string $mountPoint
-	 * @return \OC\Files\Storage\Storage|null
-	 */
-	public static function getStorage($mountPoint) {
-		$mount = self::getMountManager()->find($mountPoint);
-		return $mount->getStorage();
-	}
-
-	/**
-	 * @param string $id
-	 * @return Mount\MountPoint[]
-	 */
-	public static function getMountByStorageId($id) {
-		return self::getMountManager()->findByStorageId($id);
-	}
-
-	/**
-	 * @param int $id
-	 * @return Mount\MountPoint[]
-	 */
-	public static function getMountByNumericId($id) {
-		return self::getMountManager()->findByNumericId($id);
-	}
-
-	/**
-	 * resolve a path to a storage and internal path
-	 *
-	 * @param string $path
-	 * @return array an array consisting of the storage and the internal path
-	 */
-	public static function resolvePath($path) {
-		$mount = self::getMountManager()->find($path);
-		return [$mount->getStorage(), rtrim($mount->getInternalPath($path), '/')];
-	}
-
-	public static function init($user, $root) {
-		if (self::$defaultInstance) {
-			return false;
-		}
-		self::getLoader();
-		self::$defaultInstance = new View($root);
-		/** @var IEventDispatcher $eventDispatcher */
-		$eventDispatcher = \OC::$server->get(IEventDispatcher::class);
-		$eventDispatcher->addListener(FilesystemTornDownEvent::class, function () {
-			self::$defaultInstance = null;
-			self::$usersSetup = [];
-			self::$loaded = false;
-		});
-
-		if (!self::$mounts) {
-			self::$mounts = \OC::$server->getMountManager();
-		}
-
-		//load custom mount config
-		self::initMountPoints($user);
-
-		self::$loaded = true;
-
-		return true;
-	}
-
-	public static function initMountManager() {
-		if (!self::$mounts) {
-			self::$mounts = \OC::$server->getMountManager();
-		}
-	}
-
-	/**
-	 * Initialize system and personal mount points for a user
-	 *
-	 * @param string|IUser|null $user
-	 * @throws \OC\User\NoUserException if the user is not available
-	 */
-	public static function initMountPoints($user = '') {
-		/** @var IUserManager $userManager */
-		$userManager = \OC::$server->get(IUserManager::class);
-
-		$userObject = ($user instanceof IUser) ? $user : $userManager->get($user);
-		if ($userObject) {
-			/** @var SetupManager $setupManager */
-			$setupManager = \OC::$server->get(SetupManager::class);
-			$setupManager->setupForUser($userObject);
-		} else {
-			throw new NoUserException();
-		}
-	}
-
-	/**
-	 * get the default filesystem view
-	 *
-	 * @return View
-	 */
-	public static function getView() {
-		return self::$defaultInstance;
-	}
-
-	/**
-	 * tear down the filesystem, removing all storage providers
-	 */
-	public static function tearDown() {
-		\OC_Util::tearDownFS();
-	}
-
-	/**
-	 * get the relative path of the root data directory for the current user
-	 *
-	 * @return string
-	 *
-	 * Returns path like /admin/files
-	 */
-	public static function getRoot() {
-		if (!self::$defaultInstance) {
-			return null;
-		}
-		return self::$defaultInstance->getRoot();
-	}
-
-	/**
-	 * mount an \OC\Files\Storage\Storage in our virtual filesystem
-	 *
-	 * @param \OC\Files\Storage\Storage|string $class
-	 * @param array $arguments
-	 * @param string $mountpoint
-	 */
-	public static function mount($class, $arguments, $mountpoint) {
-		if (!self::$mounts) {
-			\OC_Util::setupFS();
-		}
-		$mount = new Mount\MountPoint($class, $mountpoint, $arguments, self::getLoader());
-		self::$mounts->addMount($mount);
-	}
-
-	/**
-	 * return the path to a local version of the file
-	 * we need this because we can't know if a file is stored local or not from
-	 * outside the filestorage and for some purposes a local file is needed
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public static function getLocalFile($path) {
-		return self::$defaultInstance->getLocalFile($path);
-	}
-
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	public static function getLocalFolder($path) {
-		return self::$defaultInstance->getLocalFolder($path);
-	}
-
-	/**
-	 * return path to file which reflects one visible in browser
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public static function getLocalPath($path) {
-		$datadir = \OC_User::getHome(\OC_User::getUser()) . '/files';
-		$newpath = $path;
-		if (strncmp($newpath, $datadir, strlen($datadir)) == 0) {
-			$newpath = substr($path, strlen($datadir));
-		}
-		return $newpath;
-	}
-
-	/**
-	 * check if the requested path is valid
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	public static function isValidPath($path) {
-		$path = self::normalizePath($path);
-		if (!$path || $path[0] !== '/') {
-			$path = '/' . $path;
-		}
-		if (strpos($path, '/../') !== false || strrchr($path, '/') === '/..') {
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	 * checks if a file is blacklisted for storage in the filesystem
-	 * Listens to write and rename hooks
-	 *
-	 * @param array $data from hook
-	 */
-	public static function isBlacklisted($data) {
-		if (isset($data['path'])) {
-			$path = $data['path'];
-		} elseif (isset($data['newpath'])) {
-			$path = $data['newpath'];
-		}
-		if (isset($path)) {
-			if (self::isFileBlacklisted($path)) {
-				$data['run'] = false;
-			}
-		}
-	}
-
-	/**
-	 * @param string $filename
-	 * @return bool
-	 */
-	public static function isFileBlacklisted($filename) {
-		$filename = self::normalizePath($filename);
-
-		if (self::$blacklist === null) {
-			self::$blacklist = \OC::$server->getConfig()->getSystemValue('blacklisted_files', ['.htaccess']);
-		}
-
-		$filename = strtolower(basename($filename));
-		return in_array($filename, self::$blacklist);
-	}
-
-	/**
-	 * check if the directory should be ignored when scanning
-	 * NOTE: the special directories . and .. would cause never ending recursion
-	 *
-	 * @param string $dir
-	 * @return boolean
-	 */
-	public static function isIgnoredDir($dir) {
-		if ($dir === '.' || $dir === '..') {
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * following functions are equivalent to their php builtin equivalents for arguments/return values.
-	 */
-	public static function mkdir($path) {
-		return self::$defaultInstance->mkdir($path);
-	}
-
-	public static function rmdir($path) {
-		return self::$defaultInstance->rmdir($path);
-	}
-
-	public static function is_dir($path) {
-		return self::$defaultInstance->is_dir($path);
-	}
-
-	public static function is_file($path) {
-		return self::$defaultInstance->is_file($path);
-	}
-
-	public static function stat($path) {
-		return self::$defaultInstance->stat($path);
-	}
-
-	public static function filetype($path) {
-		return self::$defaultInstance->filetype($path);
-	}
-
-	public static function filesize($path) {
-		return self::$defaultInstance->filesize($path);
-	}
-
-	public static function readfile($path) {
-		return self::$defaultInstance->readfile($path);
-	}
-
-	public static function isCreatable($path) {
-		return self::$defaultInstance->isCreatable($path);
-	}
-
-	public static function isReadable($path) {
-		return self::$defaultInstance->isReadable($path);
-	}
-
-	public static function isUpdatable($path) {
-		return self::$defaultInstance->isUpdatable($path);
-	}
-
-	public static function isDeletable($path) {
-		return self::$defaultInstance->isDeletable($path);
-	}
-
-	public static function isSharable($path) {
-		return self::$defaultInstance->isSharable($path);
-	}
-
-	public static function file_exists($path) {
-		return self::$defaultInstance->file_exists($path);
-	}
-
-	public static function filemtime($path) {
-		return self::$defaultInstance->filemtime($path);
-	}
-
-	public static function touch($path, $mtime = null) {
-		return self::$defaultInstance->touch($path, $mtime);
-	}
-
-	/**
-	 * @return string
-	 */
-	public static function file_get_contents($path) {
-		return self::$defaultInstance->file_get_contents($path);
-	}
-
-	public static function file_put_contents($path, $data) {
-		return self::$defaultInstance->file_put_contents($path, $data);
-	}
-
-	public static function unlink($path) {
-		return self::$defaultInstance->unlink($path);
-	}
-
-	public static function rename($path1, $path2) {
-		return self::$defaultInstance->rename($path1, $path2);
-	}
-
-	public static function copy($path1, $path2) {
-		return self::$defaultInstance->copy($path1, $path2);
-	}
-
-	public static function fopen($path, $mode) {
-		return self::$defaultInstance->fopen($path, $mode);
-	}
-
-	/**
-	 * @return string
-	 */
-	public static function toTmpFile($path) {
-		return self::$defaultInstance->toTmpFile($path);
-	}
-
-	public static function fromTmpFile($tmpFile, $path) {
-		return self::$defaultInstance->fromTmpFile($tmpFile, $path);
-	}
-
-	public static function getMimeType($path) {
-		return self::$defaultInstance->getMimeType($path);
-	}
-
-	public static function hash($type, $path, $raw = false) {
-		return self::$defaultInstance->hash($type, $path, $raw);
-	}
-
-	public static function free_space($path = '/') {
-		return self::$defaultInstance->free_space($path);
-	}
-
-	public static function search($query) {
-		return self::$defaultInstance->search($query);
-	}
-
-	/**
-	 * @param string $query
-	 */
-	public static function searchByMime($query) {
-		return self::$defaultInstance->searchByMime($query);
-	}
-
-	/**
-	 * @param string|int $tag name or tag id
-	 * @param string $userId owner of the tags
-	 * @return FileInfo[] array or file info
-	 */
-	public static function searchByTag($tag, $userId) {
-		return self::$defaultInstance->searchByTag($tag, $userId);
-	}
-
-	/**
-	 * check if a file or folder has been updated since $time
-	 *
-	 * @param string $path
-	 * @param int $time
-	 * @return bool
-	 */
-	public static function hasUpdated($path, $time) {
-		return self::$defaultInstance->hasUpdated($path, $time);
-	}
-
-	/**
-	 * Fix common problems with a file path
-	 *
-	 * @param string $path
-	 * @param bool $stripTrailingSlash whether to strip the trailing slash
-	 * @param bool $isAbsolutePath whether the given path is absolute
-	 * @param bool $keepUnicode true to disable unicode normalization
-	 * @return string
-	 */
-	public static function normalizePath($path, $stripTrailingSlash = true, $isAbsolutePath = false, $keepUnicode = false) {
-		/**
-		 * FIXME: This is a workaround for existing classes and files which call
-		 *        this function with another type than a valid string. This
-		 *        conversion should get removed as soon as all existing
-		 *        function calls have been fixed.
-		 */
-		$path = (string)$path;
-
-		if ($path === '') {
-			return '/';
-		}
-
-		if (is_null(self::$normalizedPathCache)) {
-			self::$normalizedPathCache = new CappedMemoryCache(2048);
-		}
-
-		$cacheKey = json_encode([$path, $stripTrailingSlash, $isAbsolutePath, $keepUnicode]);
-
-		if ($cacheKey && isset(self::$normalizedPathCache[$cacheKey])) {
-			return self::$normalizedPathCache[$cacheKey];
-		}
-
-		//normalize unicode if possible
-		if (!$keepUnicode) {
-			$path = \OC_Util::normalizeUnicode($path);
-		}
-
-		//add leading slash, if it is already there we strip it anyway
-		$path = '/' . $path;
-
-		$patterns = [
-			'#\\\\#s',       // no windows style '\\' slashes
-			'#/\.(/\.)*/#s', // remove '/./'
-			'#\//+#s',       // remove sequence of slashes
-			'#/\.$#s',       // remove trailing '/.'
-		];
-
-		do {
-			$count = 0;
-			$path = preg_replace($patterns, '/', $path, -1, $count);
-		} while ($count > 0);
-
-		//remove trailing slash
-		if ($stripTrailingSlash && strlen($path) > 1) {
-			$path = rtrim($path, '/');
-		}
-
-		self::$normalizedPathCache[$cacheKey] = $path;
-
-		return $path;
-	}
-
-	/**
-	 * get the filesystem info
-	 *
-	 * @param string $path
-	 * @param boolean $includeMountPoints whether to add mountpoint sizes,
-	 * defaults to true
-	 * @return \OC\Files\FileInfo|false False if file does not exist
-	 */
-	public static function getFileInfo($path, $includeMountPoints = true) {
-		return self::$defaultInstance->getFileInfo($path, $includeMountPoints);
-	}
-
-	/**
-	 * change file metadata
-	 *
-	 * @param string $path
-	 * @param array $data
-	 * @return int
-	 *
-	 * returns the fileid of the updated file
-	 */
-	public static function putFileInfo($path, $data) {
-		return self::$defaultInstance->putFileInfo($path, $data);
-	}
-
-	/**
-	 * get the content of a directory
-	 *
-	 * @param string $directory path under datadirectory
-	 * @param string $mimetype_filter limit returned content to this mimetype or mimepart
-	 * @return \OC\Files\FileInfo[]
-	 */
-	public static function getDirectoryContent($directory, $mimetype_filter = '') {
-		return self::$defaultInstance->getDirectoryContent($directory, $mimetype_filter);
-	}
-
-	/**
-	 * Get the path of a file by id
-	 *
-	 * Note that the resulting path is not guaranteed to be unique for the id, multiple paths can point to the same file
-	 *
-	 * @param int $id
-	 * @throws NotFoundException
-	 * @return string
-	 */
-	public static function getPath($id) {
-		return self::$defaultInstance->getPath($id);
-	}
-
-	/**
-	 * Get the owner for a file or folder
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public static function getOwner($path) {
-		return self::$defaultInstance->getOwner($path);
-	}
-
-	/**
-	 * get the ETag for a file or folder
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	public static function getETag($path) {
-		return self::$defaultInstance->getETag($path);
-	}
+    /**
+     * @var Mount\Manager $mounts
+     */
+    private static $mounts;
+
+    public static $loaded = false;
+    /**
+     * @var \OC\Files\View $defaultInstance
+     */
+    private static $defaultInstance;
+
+    private static $usersSetup = [];
+
+    private static $normalizedPathCache = null;
+
+    private static $listeningForProviders = false;
+
+    /** @var string[]|null */
+    private static $blacklist = null;
+
+    /**
+     * classname which used for hooks handling
+     * used as signalclass in OC_Hooks::emit()
+     */
+    public const CLASSNAME = 'OC_Filesystem';
+
+    /**
+     * signalname emitted before file renaming
+     *
+     * @param string $oldpath
+     * @param string $newpath
+     */
+    public const signal_rename = 'rename';
+
+    /**
+     * signal emitted after file renaming
+     *
+     * @param string $oldpath
+     * @param string $newpath
+     */
+    public const signal_post_rename = 'post_rename';
+
+    /**
+     * signal emitted before file/dir creation
+     *
+     * @param string $path
+     * @param bool $run changing this flag to false in hook handler will cancel event
+     */
+    public const signal_create = 'create';
+
+    /**
+     * signal emitted after file/dir creation
+     *
+     * @param string $path
+     * @param bool $run changing this flag to false in hook handler will cancel event
+     */
+    public const signal_post_create = 'post_create';
+
+    /**
+     * signal emits before file/dir copy
+     *
+     * @param string $oldpath
+     * @param string $newpath
+     * @param bool $run changing this flag to false in hook handler will cancel event
+     */
+    public const signal_copy = 'copy';
+
+    /**
+     * signal emits after file/dir copy
+     *
+     * @param string $oldpath
+     * @param string $newpath
+     */
+    public const signal_post_copy = 'post_copy';
+
+    /**
+     * signal emits before file/dir save
+     *
+     * @param string $path
+     * @param bool $run changing this flag to false in hook handler will cancel event
+     */
+    public const signal_write = 'write';
+
+    /**
+     * signal emits after file/dir save
+     *
+     * @param string $path
+     */
+    public const signal_post_write = 'post_write';
+
+    /**
+     * signal emitted before file/dir update
+     *
+     * @param string $path
+     * @param bool $run changing this flag to false in hook handler will cancel event
+     */
+    public const signal_update = 'update';
+
+    /**
+     * signal emitted after file/dir update
+     *
+     * @param string $path
+     * @param bool $run changing this flag to false in hook handler will cancel event
+     */
+    public const signal_post_update = 'post_update';
+
+    /**
+     * signal emits when reading file/dir
+     *
+     * @param string $path
+     */
+    public const signal_read = 'read';
+
+    /**
+     * signal emits when removing file/dir
+     *
+     * @param string $path
+     */
+    public const signal_delete = 'delete';
+
+    /**
+     * parameters definitions for signals
+     */
+    public const signal_param_path = 'path';
+    public const signal_param_oldpath = 'oldpath';
+    public const signal_param_newpath = 'newpath';
+
+    /**
+     * run - changing this flag to false in hook handler will cancel event
+     */
+    public const signal_param_run = 'run';
+
+    public const signal_create_mount = 'create_mount';
+    public const signal_delete_mount = 'delete_mount';
+    public const signal_param_mount_type = 'mounttype';
+    public const signal_param_users = 'users';
+
+    /**
+     * @var \OC\Files\Storage\StorageFactory $loader
+     */
+    private static $loader;
+
+    /** @var bool */
+    private static $logWarningWhenAddingStorageWrapper = true;
+
+    /**
+     * @param bool $shouldLog
+     * @return bool previous value
+     * @internal
+     */
+    public static function logWarningWhenAddingStorageWrapper($shouldLog) {
+        $previousValue = self::$logWarningWhenAddingStorageWrapper;
+        self::$logWarningWhenAddingStorageWrapper = (bool) $shouldLog;
+        return $previousValue;
+    }
+
+    /**
+     * @param string $wrapperName
+     * @param callable $wrapper
+     * @param int $priority
+     */
+    public static function addStorageWrapper($wrapperName, $wrapper, $priority = 50) {
+        if (self::$logWarningWhenAddingStorageWrapper) {
+            \OC::$server->getLogger()->warning("Storage wrapper '{wrapper}' was not registered via the 'OC_Filesystem - preSetup' hook which could cause potential problems.", [
+                'wrapper' => $wrapperName,
+                'app' => 'filesystem',
+            ]);
+        }
+
+        $mounts = self::getMountManager()->getAll();
+        if (!self::getLoader()->addStorageWrapper($wrapperName, $wrapper, $priority, $mounts)) {
+            // do not re-wrap if storage with this name already existed
+            return;
+        }
+    }
+
+    /**
+     * Returns the storage factory
+     *
+     * @return IStorageFactory
+     */
+    public static function getLoader() {
+        if (!self::$loader) {
+            self::$loader = \OC::$server->query(IStorageFactory::class);
+        }
+        return self::$loader;
+    }
+
+    /**
+     * Returns the mount manager
+     *
+     * @return \OC\Files\Mount\Manager
+     */
+    public static function getMountManager($user = '') {
+        self::initMountManager();
+        return self::$mounts;
+    }
+
+    /**
+     * get the mountpoint of the storage object for a path
+     * ( note: because a storage is not always mounted inside the fakeroot, the
+     * returned mountpoint is relative to the absolute root of the filesystem
+     * and doesn't take the chroot into account )
+     *
+     * @param string $path
+     * @return string
+     */
+    public static function getMountPoint($path) {
+        if (!self::$mounts) {
+            \OC_Util::setupFS();
+        }
+        $mount = self::$mounts->find($path);
+        return $mount->getMountPoint();
+    }
+
+    /**
+     * get a list of all mount points in a directory
+     *
+     * @param string $path
+     * @return string[]
+     */
+    public static function getMountPoints($path) {
+        if (!self::$mounts) {
+            \OC_Util::setupFS();
+        }
+        $result = [];
+        $mounts = self::$mounts->findIn($path);
+        foreach ($mounts as $mount) {
+            $result[] = $mount->getMountPoint();
+        }
+        return $result;
+    }
+
+    /**
+     * get the storage mounted at $mountPoint
+     *
+     * @param string $mountPoint
+     * @return \OC\Files\Storage\Storage|null
+     */
+    public static function getStorage($mountPoint) {
+        $mount = self::getMountManager()->find($mountPoint);
+        return $mount->getStorage();
+    }
+
+    /**
+     * @param string $id
+     * @return Mount\MountPoint[]
+     */
+    public static function getMountByStorageId($id) {
+        return self::getMountManager()->findByStorageId($id);
+    }
+
+    /**
+     * @param int $id
+     * @return Mount\MountPoint[]
+     */
+    public static function getMountByNumericId($id) {
+        return self::getMountManager()->findByNumericId($id);
+    }
+
+    /**
+     * resolve a path to a storage and internal path
+     *
+     * @param string $path
+     * @return array an array consisting of the storage and the internal path
+     */
+    public static function resolvePath($path) {
+        $mount = self::getMountManager()->find($path);
+        return [$mount->getStorage(), rtrim($mount->getInternalPath($path), '/')];
+    }
+
+    public static function init($user, $root) {
+        if (self::$defaultInstance) {
+            return false;
+        }
+        self::getLoader();
+        self::$defaultInstance = new View($root);
+        /** @var IEventDispatcher $eventDispatcher */
+        $eventDispatcher = \OC::$server->get(IEventDispatcher::class);
+        $eventDispatcher->addListener(FilesystemTornDownEvent::class, function () {
+            self::$defaultInstance = null;
+            self::$usersSetup = [];
+            self::$loaded = false;
+        });
+
+        if (!self::$mounts) {
+            self::$mounts = \OC::$server->getMountManager();
+        }
+
+        //load custom mount config
+        self::initMountPoints($user);
+
+        self::$loaded = true;
+
+        return true;
+    }
+
+    public static function initMountManager() {
+        if (!self::$mounts) {
+            self::$mounts = \OC::$server->getMountManager();
+        }
+    }
+
+    /**
+     * Initialize system and personal mount points for a user
+     *
+     * @param string|IUser|null $user
+     * @throws \OC\User\NoUserException if the user is not available
+     */
+    public static function initMountPoints($user = '') {
+        /** @var IUserManager $userManager */
+        $userManager = \OC::$server->get(IUserManager::class);
+
+        $userObject = ($user instanceof IUser) ? $user : $userManager->get($user);
+        if ($userObject) {
+            /** @var SetupManager $setupManager */
+            $setupManager = \OC::$server->get(SetupManager::class);
+            $setupManager->setupForUser($userObject);
+        } else {
+            throw new NoUserException();
+        }
+    }
+
+    /**
+     * get the default filesystem view
+     *
+     * @return View
+     */
+    public static function getView() {
+        return self::$defaultInstance;
+    }
+
+    /**
+     * tear down the filesystem, removing all storage providers
+     */
+    public static function tearDown() {
+        \OC_Util::tearDownFS();
+    }
+
+    /**
+     * get the relative path of the root data directory for the current user
+     *
+     * @return string
+     *
+     * Returns path like /admin/files
+     */
+    public static function getRoot() {
+        if (!self::$defaultInstance) {
+            return null;
+        }
+        return self::$defaultInstance->getRoot();
+    }
+
+    /**
+     * mount an \OC\Files\Storage\Storage in our virtual filesystem
+     *
+     * @param \OC\Files\Storage\Storage|string $class
+     * @param array $arguments
+     * @param string $mountpoint
+     */
+    public static function mount($class, $arguments, $mountpoint) {
+        if (!self::$mounts) {
+            \OC_Util::setupFS();
+        }
+        $mount = new Mount\MountPoint($class, $mountpoint, $arguments, self::getLoader());
+        self::$mounts->addMount($mount);
+    }
+
+    /**
+     * return the path to a local version of the file
+     * we need this because we can't know if a file is stored local or not from
+     * outside the filestorage and for some purposes a local file is needed
+     *
+     * @param string $path
+     * @return string
+     */
+    public static function getLocalFile($path) {
+        return self::$defaultInstance->getLocalFile($path);
+    }
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    public static function getLocalFolder($path) {
+        return self::$defaultInstance->getLocalFolder($path);
+    }
+
+    /**
+     * return path to file which reflects one visible in browser
+     *
+     * @param string $path
+     * @return string
+     */
+    public static function getLocalPath($path) {
+        $datadir = \OC_User::getHome(\OC_User::getUser()) . '/files';
+        $newpath = $path;
+        if (strncmp($newpath, $datadir, strlen($datadir)) == 0) {
+            $newpath = substr($path, strlen($datadir));
+        }
+        return $newpath;
+    }
+
+    /**
+     * check if the requested path is valid
+     *
+     * @param string $path
+     * @return bool
+     */
+    public static function isValidPath($path) {
+        $path = self::normalizePath($path);
+        if (!$path || $path[0] !== '/') {
+            $path = '/' . $path;
+        }
+        if (strpos($path, '/../') !== false || strrchr($path, '/') === '/..') {
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * checks if a file is blacklisted for storage in the filesystem
+     * Listens to write and rename hooks
+     *
+     * @param array $data from hook
+     */
+    public static function isBlacklisted($data) {
+        if (isset($data['path'])) {
+            $path = $data['path'];
+        } elseif (isset($data['newpath'])) {
+            $path = $data['newpath'];
+        }
+        if (isset($path)) {
+            if (self::isFileBlacklisted($path)) {
+                $data['run'] = false;
+            }
+        }
+    }
+
+    /**
+     * @param string $filename
+     * @return bool
+     */
+    public static function isFileBlacklisted($filename) {
+        $filename = self::normalizePath($filename);
+
+        if (self::$blacklist === null) {
+            self::$blacklist = \OC::$server->getConfig()->getSystemValue('blacklisted_files', ['.htaccess']);
+        }
+
+        $filename = strtolower(basename($filename));
+        return in_array($filename, self::$blacklist);
+    }
+
+    /**
+     * check if the directory should be ignored when scanning
+     * NOTE: the special directories . and .. would cause never ending recursion
+     *
+     * @param string $dir
+     * @return boolean
+     */
+    public static function isIgnoredDir($dir) {
+        if ($dir === '.' || $dir === '..') {
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * following functions are equivalent to their php builtin equivalents for arguments/return values.
+     */
+    public static function mkdir($path) {
+        return self::$defaultInstance->mkdir($path);
+    }
+
+    public static function rmdir($path) {
+        return self::$defaultInstance->rmdir($path);
+    }
+
+    public static function is_dir($path) {
+        return self::$defaultInstance->is_dir($path);
+    }
+
+    public static function is_file($path) {
+        return self::$defaultInstance->is_file($path);
+    }
+
+    public static function stat($path) {
+        return self::$defaultInstance->stat($path);
+    }
+
+    public static function filetype($path) {
+        return self::$defaultInstance->filetype($path);
+    }
+
+    public static function filesize($path) {
+        return self::$defaultInstance->filesize($path);
+    }
+
+    public static function readfile($path) {
+        return self::$defaultInstance->readfile($path);
+    }
+
+    public static function isCreatable($path) {
+        return self::$defaultInstance->isCreatable($path);
+    }
+
+    public static function isReadable($path) {
+        return self::$defaultInstance->isReadable($path);
+    }
+
+    public static function isUpdatable($path) {
+        return self::$defaultInstance->isUpdatable($path);
+    }
+
+    public static function isDeletable($path) {
+        return self::$defaultInstance->isDeletable($path);
+    }
+
+    public static function isSharable($path) {
+        return self::$defaultInstance->isSharable($path);
+    }
+
+    public static function file_exists($path) {
+        return self::$defaultInstance->file_exists($path);
+    }
+
+    public static function filemtime($path) {
+        return self::$defaultInstance->filemtime($path);
+    }
+
+    public static function touch($path, $mtime = null) {
+        return self::$defaultInstance->touch($path, $mtime);
+    }
+
+    /**
+     * @return string
+     */
+    public static function file_get_contents($path) {
+        return self::$defaultInstance->file_get_contents($path);
+    }
+
+    public static function file_put_contents($path, $data) {
+        return self::$defaultInstance->file_put_contents($path, $data);
+    }
+
+    public static function unlink($path) {
+        return self::$defaultInstance->unlink($path);
+    }
+
+    public static function rename($path1, $path2) {
+        return self::$defaultInstance->rename($path1, $path2);
+    }
+
+    public static function copy($path1, $path2) {
+        return self::$defaultInstance->copy($path1, $path2);
+    }
+
+    public static function fopen($path, $mode) {
+        return self::$defaultInstance->fopen($path, $mode);
+    }
+
+    /**
+     * @return string
+     */
+    public static function toTmpFile($path) {
+        return self::$defaultInstance->toTmpFile($path);
+    }
+
+    public static function fromTmpFile($tmpFile, $path) {
+        return self::$defaultInstance->fromTmpFile($tmpFile, $path);
+    }
+
+    public static function getMimeType($path) {
+        return self::$defaultInstance->getMimeType($path);
+    }
+
+    public static function hash($type, $path, $raw = false) {
+        return self::$defaultInstance->hash($type, $path, $raw);
+    }
+
+    public static function free_space($path = '/') {
+        return self::$defaultInstance->free_space($path);
+    }
+
+    public static function search($query) {
+        return self::$defaultInstance->search($query);
+    }
+
+    /**
+     * @param string $query
+     */
+    public static function searchByMime($query) {
+        return self::$defaultInstance->searchByMime($query);
+    }
+
+    /**
+     * @param string|int $tag name or tag id
+     * @param string $userId owner of the tags
+     * @return FileInfo[] array or file info
+     */
+    public static function searchByTag($tag, $userId) {
+        return self::$defaultInstance->searchByTag($tag, $userId);
+    }
+
+    /**
+     * check if a file or folder has been updated since $time
+     *
+     * @param string $path
+     * @param int $time
+     * @return bool
+     */
+    public static function hasUpdated($path, $time) {
+        return self::$defaultInstance->hasUpdated($path, $time);
+    }
+
+    /**
+     * Fix common problems with a file path
+     *
+     * @param string $path
+     * @param bool $stripTrailingSlash whether to strip the trailing slash
+     * @param bool $isAbsolutePath whether the given path is absolute
+     * @param bool $keepUnicode true to disable unicode normalization
+     * @return string
+     */
+    public static function normalizePath($path, $stripTrailingSlash = true, $isAbsolutePath = false, $keepUnicode = false) {
+        /**
+         * FIXME: This is a workaround for existing classes and files which call
+         *        this function with another type than a valid string. This
+         *        conversion should get removed as soon as all existing
+         *        function calls have been fixed.
+         */
+        $path = (string)$path;
+
+        if ($path === '') {
+            return '/';
+        }
+
+        if (is_null(self::$normalizedPathCache)) {
+            self::$normalizedPathCache = new CappedMemoryCache(2048);
+        }
+
+        $cacheKey = json_encode([$path, $stripTrailingSlash, $isAbsolutePath, $keepUnicode]);
+
+        if ($cacheKey && isset(self::$normalizedPathCache[$cacheKey])) {
+            return self::$normalizedPathCache[$cacheKey];
+        }
+
+        //normalize unicode if possible
+        if (!$keepUnicode) {
+            $path = \OC_Util::normalizeUnicode($path);
+        }
+
+        //add leading slash, if it is already there we strip it anyway
+        $path = '/' . $path;
+
+        $patterns = [
+            '#\\\\#s',       // no windows style '\\' slashes
+            '#/\.(/\.)*/#s', // remove '/./'
+            '#\//+#s',       // remove sequence of slashes
+            '#/\.$#s',       // remove trailing '/.'
+        ];
+
+        do {
+            $count = 0;
+            $path = preg_replace($patterns, '/', $path, -1, $count);
+        } while ($count > 0);
+
+        //remove trailing slash
+        if ($stripTrailingSlash && strlen($path) > 1) {
+            $path = rtrim($path, '/');
+        }
+
+        self::$normalizedPathCache[$cacheKey] = $path;
+
+        return $path;
+    }
+
+    /**
+     * get the filesystem info
+     *
+     * @param string $path
+     * @param boolean $includeMountPoints whether to add mountpoint sizes,
+     * defaults to true
+     * @return \OC\Files\FileInfo|false False if file does not exist
+     */
+    public static function getFileInfo($path, $includeMountPoints = true) {
+        return self::$defaultInstance->getFileInfo($path, $includeMountPoints);
+    }
+
+    /**
+     * change file metadata
+     *
+     * @param string $path
+     * @param array $data
+     * @return int
+     *
+     * returns the fileid of the updated file
+     */
+    public static function putFileInfo($path, $data) {
+        return self::$defaultInstance->putFileInfo($path, $data);
+    }
+
+    /**
+     * get the content of a directory
+     *
+     * @param string $directory path under datadirectory
+     * @param string $mimetype_filter limit returned content to this mimetype or mimepart
+     * @return \OC\Files\FileInfo[]
+     */
+    public static function getDirectoryContent($directory, $mimetype_filter = '') {
+        return self::$defaultInstance->getDirectoryContent($directory, $mimetype_filter);
+    }
+
+    /**
+     * Get the path of a file by id
+     *
+     * Note that the resulting path is not guaranteed to be unique for the id, multiple paths can point to the same file
+     *
+     * @param int $id
+     * @throws NotFoundException
+     * @return string
+     */
+    public static function getPath($id) {
+        return self::$defaultInstance->getPath($id);
+    }
+
+    /**
+     * Get the owner for a file or folder
+     *
+     * @param string $path
+     * @return string
+     */
+    public static function getOwner($path) {
+        return self::$defaultInstance->getOwner($path);
+    }
+
+    /**
+     * get the ETag for a file or folder
+     *
+     * @param string $path
+     * @return string
+     */
+    public static function getETag($path) {
+        return self::$defaultInstance->getETag($path);
+    }
 }

lib/private/Files/Cache/Scanner.php

Indentation +508 added lines, -508 removed lines

@@ -56,512 +56,512 @@
  * @package OC\Files\Cache
  */
 class Scanner extends BasicEmitter implements IScanner {
-	/**
-	 * @var \OC\Files\Storage\Storage $storage
-	 */
-	protected $storage;
-
-	/**
-	 * @var string $storageId
-	 */
-	protected $storageId;
-
-	/**
-	 * @var \OC\Files\Cache\Cache $cache
-	 */
-	protected $cache;
-
-	/**
-	 * @var boolean $cacheActive If true, perform cache operations, if false, do not affect cache
-	 */
-	protected $cacheActive;
-
-	/**
-	 * @var bool $useTransactions whether to use transactions
-	 */
-	protected $useTransactions = true;
-
-	/**
-	 * @var \OCP\Lock\ILockingProvider
-	 */
-	protected $lockingProvider;
-
-	public function __construct(\OC\Files\Storage\Storage $storage) {
-		$this->storage = $storage;
-		$this->storageId = $this->storage->getId();
-		$this->cache = $storage->getCache();
-		$this->cacheActive = !\OC::$server->getConfig()->getSystemValue('filesystem_cache_readonly', false);
-		$this->lockingProvider = \OC::$server->getLockingProvider();
-	}
-
-	/**
-	 * Whether to wrap the scanning of a folder in a database transaction
-	 * On default transactions are used
-	 *
-	 * @param bool $useTransactions
-	 */
-	public function setUseTransactions($useTransactions) {
-		$this->useTransactions = $useTransactions;
-	}
-
-	/**
-	 * get all the metadata of a file or folder
-	 * *
-	 *
-	 * @param string $path
-	 * @return array|null an array of metadata of the file
-	 */
-	protected function getData($path) {
-		$data = $this->storage->getMetaData($path);
-		if (is_null($data)) {
-			\OCP\Util::writeLog(Scanner::class, "!!! Path '$path' is not accessible or present !!!", ILogger::DEBUG);
-		}
-		return $data;
-	}
-
-	/**
-	 * scan a single file and store it in the cache
-	 *
-	 * @param string $file
-	 * @param int $reuseExisting
-	 * @param int $parentId
-	 * @param array|null|false $cacheData existing data in the cache for the file to be scanned
-	 * @param bool $lock set to false to disable getting an additional read lock during scanning
-	 * @param null $data the metadata for the file, as returned by the storage
-	 * @return array|null an array of metadata of the scanned file
-	 * @throws \OCP\Lock\LockedException
-	 */
-	public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true, $data = null) {
-		if ($file !== '') {
-			try {
-				$this->storage->verifyPath(dirname($file), basename($file));
-			} catch (\Exception $e) {
-				return null;
-			}
-		}
-		// only proceed if $file is not a partial file, blacklist is handled by the storage
-		if (!self::isPartialFile($file)) {
-
-			//acquire a lock
-			if ($lock) {
-				if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-					$this->storage->acquireLock($file, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
-				}
-			}
-
-			try {
-				$data = $data ?? $this->getData($file);
-			} catch (ForbiddenException $e) {
-				if ($lock) {
-					if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-						$this->storage->releaseLock($file, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
-					}
-				}
-
-				return null;
-			}
-
-			try {
-				if ($data) {
-
-					// pre-emit only if it was a file. By that we avoid counting/treating folders as files
-					if ($data['mimetype'] !== 'httpd/unix-directory') {
-						$this->emit('\OC\Files\Cache\Scanner', 'scanFile', [$file, $this->storageId]);
-						\OC_Hook::emit('\OC\Files\Cache\Scanner', 'scan_file', ['path' => $file, 'storage' => $this->storageId]);
-					}
-
-					$parent = dirname($file);
-					if ($parent === '.' or $parent === '/') {
-						$parent = '';
-					}
-					if ($parentId === -1) {
-						$parentId = $this->cache->getParentId($file);
-					}
-
-					// scan the parent if it's not in the cache (id -1) and the current file is not the root folder
-					if ($file and $parentId === -1) {
-						$parentData = $this->scanFile($parent);
-						if (!$parentData) {
-							return null;
-						}
-						$parentId = $parentData['fileid'];
-					}
-					if ($parent) {
-						$data['parent'] = $parentId;
-					}
-					if (is_null($cacheData)) {
-						/** @var CacheEntry $cacheData */
-						$cacheData = $this->cache->get($file);
-					}
-					if ($cacheData and $reuseExisting and isset($cacheData['fileid'])) {
-						// prevent empty etag
-						if (empty($cacheData['etag'])) {
-							$etag = $data['etag'];
-						} else {
-							$etag = $cacheData['etag'];
-						}
-						$fileId = $cacheData['fileid'];
-						$data['fileid'] = $fileId;
-						// only reuse data if the file hasn't explicitly changed
-						if (isset($data['storage_mtime']) && isset($cacheData['storage_mtime']) && $data['storage_mtime'] === $cacheData['storage_mtime']) {
-							$data['mtime'] = $cacheData['mtime'];
-							if (($reuseExisting & self::REUSE_SIZE) && ($data['size'] === -1)) {
-								$data['size'] = $cacheData['size'];
-							}
-							if ($reuseExisting & self::REUSE_ETAG) {
-								$data['etag'] = $etag;
-							}
-						}
-						// Only update metadata that has changed
-						$newData = array_diff_assoc($data, $cacheData->getData());
-					} else {
-						$newData = $data;
-						$fileId = -1;
-					}
-					if (!empty($newData)) {
-						// Reset the checksum if the data has changed
-						$newData['checksum'] = '';
-						$newData['parent'] = $parentId;
-						$data['fileid'] = $this->addToCache($file, $newData, $fileId);
-					}
-					if ($cacheData && isset($cacheData['size'])) {
-						$data['oldSize'] = $cacheData['size'];
-					} else {
-						$data['oldSize'] = 0;
-					}
-
-					if ($cacheData && isset($cacheData['encrypted'])) {
-						$data['encrypted'] = $cacheData['encrypted'];
-					}
-
-					// post-emit only if it was a file. By that we avoid counting/treating folders as files
-					if ($data['mimetype'] !== 'httpd/unix-directory') {
-						$this->emit('\OC\Files\Cache\Scanner', 'postScanFile', [$file, $this->storageId]);
-						\OC_Hook::emit('\OC\Files\Cache\Scanner', 'post_scan_file', ['path' => $file, 'storage' => $this->storageId]);
-					}
-				} else {
-					$this->removeFromCache($file);
-				}
-			} catch (\Exception $e) {
-				if ($lock) {
-					if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-						$this->storage->releaseLock($file, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
-					}
-				}
-				throw $e;
-			}
-
-			//release the acquired lock
-			if ($lock) {
-				if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-					$this->storage->releaseLock($file, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
-				}
-			}
-
-			if ($data && !isset($data['encrypted'])) {
-				$data['encrypted'] = false;
-			}
-			return $data;
-		}
-
-		return null;
-	}
-
-	protected function removeFromCache($path) {
-		\OC_Hook::emit('Scanner', 'removeFromCache', ['file' => $path]);
-		$this->emit('\OC\Files\Cache\Scanner', 'removeFromCache', [$path]);
-		if ($this->cacheActive) {
-			$this->cache->remove($path);
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @param array $data
-	 * @param int $fileId
-	 * @return int the id of the added file
-	 */
-	protected function addToCache($path, $data, $fileId = -1) {
-		if (isset($data['scan_permissions'])) {
-			$data['permissions'] = $data['scan_permissions'];
-		}
-		\OC_Hook::emit('Scanner', 'addToCache', ['file' => $path, 'data' => $data]);
-		$this->emit('\OC\Files\Cache\Scanner', 'addToCache', [$path, $this->storageId, $data]);
-		if ($this->cacheActive) {
-			if ($fileId !== -1) {
-				$this->cache->update($fileId, $data);
-				return $fileId;
-			} else {
-				return $this->cache->insert($path, $data);
-			}
-		} else {
-			return -1;
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @param array $data
-	 * @param int $fileId
-	 */
-	protected function updateCache($path, $data, $fileId = -1) {
-		\OC_Hook::emit('Scanner', 'addToCache', ['file' => $path, 'data' => $data]);
-		$this->emit('\OC\Files\Cache\Scanner', 'updateCache', [$path, $this->storageId, $data]);
-		if ($this->cacheActive) {
-			if ($fileId !== -1) {
-				$this->cache->update($fileId, $data);
-			} else {
-				$this->cache->put($path, $data);
-			}
-		}
-	}
-
-	/**
-	 * scan a folder and all it's children
-	 *
-	 * @param string $path
-	 * @param bool $recursive
-	 * @param int $reuse
-	 * @param bool $lock set to false to disable getting an additional read lock during scanning
-	 * @return array|null an array of the meta data of the scanned file or folder
-	 */
-	public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $lock = true) {
-		if ($reuse === -1) {
-			$reuse = ($recursive === self::SCAN_SHALLOW) ? self::REUSE_ETAG | self::REUSE_SIZE : self::REUSE_ETAG;
-		}
-		if ($lock) {
-			if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-				$this->storage->acquireLock('scanner::' . $path, ILockingProvider::LOCK_EXCLUSIVE, $this->lockingProvider);
-				$this->storage->acquireLock($path, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
-			}
-		}
-		try {
-			$data = $this->scanFile($path, $reuse, -1, null, $lock);
-			if ($data and $data['mimetype'] === 'httpd/unix-directory') {
-				$size = $this->scanChildren($path, $recursive, $reuse, $data['fileid'], $lock);
-				$data['size'] = $size;
-			}
-		} finally {
-			if ($lock) {
-				if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
-					$this->storage->releaseLock($path, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
-					$this->storage->releaseLock('scanner::' . $path, ILockingProvider::LOCK_EXCLUSIVE, $this->lockingProvider);
-				}
-			}
-		}
-		return $data;
-	}
-
-	/**
-	 * Get the children currently in the cache
-	 *
-	 * @param int $folderId
-	 * @return array[]
-	 */
-	protected function getExistingChildren($folderId) {
-		$existingChildren = [];
-		$children = $this->cache->getFolderContentsById($folderId);
-		foreach ($children as $child) {
-			$existingChildren[$child['name']] = $child;
-		}
-		return $existingChildren;
-	}
-
-	/**
-	 * scan all the files and folders in a folder
-	 *
-	 * @param string $path
-	 * @param bool $recursive
-	 * @param int $reuse
-	 * @param int $folderId id for the folder to be scanned
-	 * @param bool $lock set to false to disable getting an additional read lock during scanning
-	 * @return int the size of the scanned folder or -1 if the size is unknown at this stage
-	 */
-	protected function scanChildren($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $folderId = null, $lock = true) {
-		if ($reuse === -1) {
-			$reuse = ($recursive === self::SCAN_SHALLOW) ? self::REUSE_ETAG | self::REUSE_SIZE : self::REUSE_ETAG;
-		}
-		$this->emit('\OC\Files\Cache\Scanner', 'scanFolder', [$path, $this->storageId]);
-		$size = 0;
-		if (!is_null($folderId)) {
-			$folderId = $this->cache->getId($path);
-		}
-		$childQueue = $this->handleChildren($path, $recursive, $reuse, $folderId, $lock, $size);
-
-		foreach ($childQueue as $child => $childId) {
-			$childSize = $this->scanChildren($child, $recursive, $reuse, $childId, $lock);
-			if ($childSize === -1) {
-				$size = -1;
-			} elseif ($size !== -1) {
-				$size += $childSize;
-			}
-		}
-		if ($this->cacheActive) {
-			$this->cache->update($folderId, ['size' => $size]);
-		}
-		$this->emit('\OC\Files\Cache\Scanner', 'postScanFolder', [$path, $this->storageId]);
-		return $size;
-	}
-
-	private function handleChildren($path, $recursive, $reuse, $folderId, $lock, &$size) {
-		// we put this in it's own function so it cleans up the memory before we start recursing
-		$existingChildren = $this->getExistingChildren($folderId);
-		$newChildren = iterator_to_array($this->storage->getDirectoryContent($path));
-
-		if ($this->useTransactions) {
-			\OC::$server->getDatabaseConnection()->beginTransaction();
-		}
-
-		$exceptionOccurred = false;
-		$childQueue = [];
-		$newChildNames = [];
-		foreach ($newChildren as $fileMeta) {
-			$permissions = isset($fileMeta['scan_permissions']) ? $fileMeta['scan_permissions'] : $fileMeta['permissions'];
-			if ($permissions === 0) {
-				continue;
-			}
-			$originalFile = $fileMeta['name'];
-			$file = trim(\OC\Files\Filesystem::normalizePath($originalFile), '/');
-			if (trim($originalFile, '/') !== $file) {
-				// encoding mismatch, might require compatibility wrapper
-				\OC::$server->getLogger()->debug('Scanner: Skipping non-normalized file name "'. $originalFile . '" in path "' . $path . '".', ['app' => 'core']);
-				$this->emit('\OC\Files\Cache\Scanner', 'normalizedNameMismatch', [$path ? $path . '/' . $originalFile : $originalFile]);
-				// skip this entry
-				continue;
-			}
-
-			$newChildNames[] = $file;
-			$child = $path ? $path . '/' . $file : $file;
-			try {
-				$existingData = isset($existingChildren[$file]) ? $existingChildren[$file] : false;
-				$data = $this->scanFile($child, $reuse, $folderId, $existingData, $lock, $fileMeta);
-				if ($data) {
-					if ($data['mimetype'] === 'httpd/unix-directory' and $recursive === self::SCAN_RECURSIVE) {
-						$childQueue[$child] = $data['fileid'];
-					} elseif ($data['mimetype'] === 'httpd/unix-directory' and $recursive === self::SCAN_RECURSIVE_INCOMPLETE and $data['size'] === -1) {
-						// only recurse into folders which aren't fully scanned
-						$childQueue[$child] = $data['fileid'];
-					} elseif ($data['size'] === -1) {
-						$size = -1;
-					} elseif ($size !== -1) {
-						$size += $data['size'];
-					}
-				}
-			} catch (Exception $ex) {
-				// might happen if inserting duplicate while a scanning
-				// process is running in parallel
-				// log and ignore
-				if ($this->useTransactions) {
-					\OC::$server->getDatabaseConnection()->rollback();
-					\OC::$server->getDatabaseConnection()->beginTransaction();
-				}
-				\OC::$server->getLogger()->logException($ex, [
-					'message' => 'Exception while scanning file "' . $child . '"',
-					'level' => ILogger::DEBUG,
-					'app' => 'core',
-				]);
-				$exceptionOccurred = true;
-			} catch (\OCP\Lock\LockedException $e) {
-				if ($this->useTransactions) {
-					\OC::$server->getDatabaseConnection()->rollback();
-				}
-				throw $e;
-			}
-		}
-		$removedChildren = \array_diff(array_keys($existingChildren), $newChildNames);
-		foreach ($removedChildren as $childName) {
-			$child = $path ? $path . '/' . $childName : $childName;
-			$this->removeFromCache($child);
-		}
-		if ($this->useTransactions) {
-			\OC::$server->getDatabaseConnection()->commit();
-		}
-		if ($exceptionOccurred) {
-			// It might happen that the parallel scan process has already
-			// inserted mimetypes but those weren't available yet inside the transaction
-			// To make sure to have the updated mime types in such cases,
-			// we reload them here
-			\OC::$server->getMimeTypeLoader()->reset();
-		}
-		return $childQueue;
-	}
-
-	/**
-	 * check if the file should be ignored when scanning
-	 * NOTE: files with a '.part' extension are ignored as well!
-	 *       prevents unfinished put requests to be scanned
-	 *
-	 * @param string $file
-	 * @return boolean
-	 */
-	public static function isPartialFile($file) {
-		if (pathinfo($file, PATHINFO_EXTENSION) === 'part') {
-			return true;
-		}
-		if (strpos($file, '.part/') !== false) {
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * walk over any folders that are not fully scanned yet and scan them
-	 */
-	public function backgroundScan() {
-		if ($this->storage->instanceOfStorage(Jail::class)) {
-			// for jail storage wrappers (shares, groupfolders) we run the background scan on the source storage
-			// this is mainly done because the jail wrapper doesn't implement `getIncomplete` (because it would be inefficient).
-			//
-			// Running the scan on the source storage might scan more than "needed", but the unscanned files outside the jail will
-			// have to be scanned at some point anyway.
-			$unJailedScanner = $this->storage->getUnjailedStorage()->getScanner();
-			$unJailedScanner->backgroundScan();
-		} else {
-			if (!$this->cache->inCache('')) {
-				// if the storage isn't in the cache yet, just scan the root completely
-				$this->runBackgroundScanJob(function () {
-					$this->scan('', self::SCAN_RECURSIVE, self::REUSE_ETAG);
-				}, '');
-			} else {
-				$lastPath = null;
-				// find any path marked as unscanned and run the scanner until no more paths are unscanned (or we get stuck)
-				while (($path = $this->cache->getIncomplete()) !== false && $path !== $lastPath) {
-					$this->runBackgroundScanJob(function () use ($path) {
-						$this->scan($path, self::SCAN_RECURSIVE_INCOMPLETE, self::REUSE_ETAG | self::REUSE_SIZE);
-					}, $path);
-					// FIXME: this won't proceed with the next item, needs revamping of getIncomplete()
-					// to make this possible
-					$lastPath = $path;
-				}
-			}
-		}
-	}
-
-	private function runBackgroundScanJob(callable $callback, $path) {
-		try {
-			$callback();
-			\OC_Hook::emit('Scanner', 'correctFolderSize', ['path' => $path]);
-			if ($this->cacheActive && $this->cache instanceof Cache) {
-				$this->cache->correctFolderSize($path, null, true);
-			}
-		} catch (\OCP\Files\StorageInvalidException $e) {
-			// skip unavailable storages
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			// skip unavailable storages
-		} catch (\OCP\Files\ForbiddenException $e) {
-			// skip forbidden storages
-		} catch (\OCP\Lock\LockedException $e) {
-			// skip unavailable storages
-		}
-	}
-
-	/**
-	 * Set whether the cache is affected by scan operations
-	 *
-	 * @param boolean $active The active state of the cache
-	 */
-	public function setCacheActive($active) {
-		$this->cacheActive = $active;
-	}
+    /**
+     * @var \OC\Files\Storage\Storage $storage
+     */
+    protected $storage;
+
+    /**
+     * @var string $storageId
+     */
+    protected $storageId;
+
+    /**
+     * @var \OC\Files\Cache\Cache $cache
+     */
+    protected $cache;
+
+    /**
+     * @var boolean $cacheActive If true, perform cache operations, if false, do not affect cache
+     */
+    protected $cacheActive;
+
+    /**
+     * @var bool $useTransactions whether to use transactions
+     */
+    protected $useTransactions = true;
+
+    /**
+     * @var \OCP\Lock\ILockingProvider
+     */
+    protected $lockingProvider;
+
+    public function __construct(\OC\Files\Storage\Storage $storage) {
+        $this->storage = $storage;
+        $this->storageId = $this->storage->getId();
+        $this->cache = $storage->getCache();
+        $this->cacheActive = !\OC::$server->getConfig()->getSystemValue('filesystem_cache_readonly', false);
+        $this->lockingProvider = \OC::$server->getLockingProvider();
+    }
+
+    /**
+     * Whether to wrap the scanning of a folder in a database transaction
+     * On default transactions are used
+     *
+     * @param bool $useTransactions
+     */
+    public function setUseTransactions($useTransactions) {
+        $this->useTransactions = $useTransactions;
+    }
+
+    /**
+     * get all the metadata of a file or folder
+     * *
+     *
+     * @param string $path
+     * @return array|null an array of metadata of the file
+     */
+    protected function getData($path) {
+        $data = $this->storage->getMetaData($path);
+        if (is_null($data)) {
+            \OCP\Util::writeLog(Scanner::class, "!!! Path '$path' is not accessible or present !!!", ILogger::DEBUG);
+        }
+        return $data;
+    }
+
+    /**
+     * scan a single file and store it in the cache
+     *
+     * @param string $file
+     * @param int $reuseExisting
+     * @param int $parentId
+     * @param array|null|false $cacheData existing data in the cache for the file to be scanned
+     * @param bool $lock set to false to disable getting an additional read lock during scanning
+     * @param null $data the metadata for the file, as returned by the storage
+     * @return array|null an array of metadata of the scanned file
+     * @throws \OCP\Lock\LockedException
+     */
+    public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true, $data = null) {
+        if ($file !== '') {
+            try {
+                $this->storage->verifyPath(dirname($file), basename($file));
+            } catch (\Exception $e) {
+                return null;
+            }
+        }
+        // only proceed if $file is not a partial file, blacklist is handled by the storage
+        if (!self::isPartialFile($file)) {
+
+            //acquire a lock
+            if ($lock) {
+                if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+                    $this->storage->acquireLock($file, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
+                }
+            }
+
+            try {
+                $data = $data ?? $this->getData($file);
+            } catch (ForbiddenException $e) {
+                if ($lock) {
+                    if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+                        $this->storage->releaseLock($file, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
+                    }
+                }
+
+                return null;
+            }
+
+            try {
+                if ($data) {
+
+                    // pre-emit only if it was a file. By that we avoid counting/treating folders as files
+                    if ($data['mimetype'] !== 'httpd/unix-directory') {
+                        $this->emit('\OC\Files\Cache\Scanner', 'scanFile', [$file, $this->storageId]);
+                        \OC_Hook::emit('\OC\Files\Cache\Scanner', 'scan_file', ['path' => $file, 'storage' => $this->storageId]);
+                    }
+
+                    $parent = dirname($file);
+                    if ($parent === '.' or $parent === '/') {
+                        $parent = '';
+                    }
+                    if ($parentId === -1) {
+                        $parentId = $this->cache->getParentId($file);
+                    }
+
+                    // scan the parent if it's not in the cache (id -1) and the current file is not the root folder
+                    if ($file and $parentId === -1) {
+                        $parentData = $this->scanFile($parent);
+                        if (!$parentData) {
+                            return null;
+                        }
+                        $parentId = $parentData['fileid'];
+                    }
+                    if ($parent) {
+                        $data['parent'] = $parentId;
+                    }
+                    if (is_null($cacheData)) {
+                        /** @var CacheEntry $cacheData */
+                        $cacheData = $this->cache->get($file);
+                    }
+                    if ($cacheData and $reuseExisting and isset($cacheData['fileid'])) {
+                        // prevent empty etag
+                        if (empty($cacheData['etag'])) {
+                            $etag = $data['etag'];
+                        } else {
+                            $etag = $cacheData['etag'];
+                        }
+                        $fileId = $cacheData['fileid'];
+                        $data['fileid'] = $fileId;
+                        // only reuse data if the file hasn't explicitly changed
+                        if (isset($data['storage_mtime']) && isset($cacheData['storage_mtime']) && $data['storage_mtime'] === $cacheData['storage_mtime']) {
+                            $data['mtime'] = $cacheData['mtime'];
+                            if (($reuseExisting & self::REUSE_SIZE) && ($data['size'] === -1)) {
+                                $data['size'] = $cacheData['size'];
+                            }
+                            if ($reuseExisting & self::REUSE_ETAG) {
+                                $data['etag'] = $etag;
+                            }
+                        }
+                        // Only update metadata that has changed
+                        $newData = array_diff_assoc($data, $cacheData->getData());
+                    } else {
+                        $newData = $data;
+                        $fileId = -1;
+                    }
+                    if (!empty($newData)) {
+                        // Reset the checksum if the data has changed
+                        $newData['checksum'] = '';
+                        $newData['parent'] = $parentId;
+                        $data['fileid'] = $this->addToCache($file, $newData, $fileId);
+                    }
+                    if ($cacheData && isset($cacheData['size'])) {
+                        $data['oldSize'] = $cacheData['size'];
+                    } else {
+                        $data['oldSize'] = 0;
+                    }
+
+                    if ($cacheData && isset($cacheData['encrypted'])) {
+                        $data['encrypted'] = $cacheData['encrypted'];
+                    }
+
+                    // post-emit only if it was a file. By that we avoid counting/treating folders as files
+                    if ($data['mimetype'] !== 'httpd/unix-directory') {
+                        $this->emit('\OC\Files\Cache\Scanner', 'postScanFile', [$file, $this->storageId]);
+                        \OC_Hook::emit('\OC\Files\Cache\Scanner', 'post_scan_file', ['path' => $file, 'storage' => $this->storageId]);
+                    }
+                } else {
+                    $this->removeFromCache($file);
+                }
+            } catch (\Exception $e) {
+                if ($lock) {
+                    if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+                        $this->storage->releaseLock($file, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
+                    }
+                }
+                throw $e;
+            }
+
+            //release the acquired lock
+            if ($lock) {
+                if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+                    $this->storage->releaseLock($file, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
+                }
+            }
+
+            if ($data && !isset($data['encrypted'])) {
+                $data['encrypted'] = false;
+            }
+            return $data;
+        }
+
+        return null;
+    }
+
+    protected function removeFromCache($path) {
+        \OC_Hook::emit('Scanner', 'removeFromCache', ['file' => $path]);
+        $this->emit('\OC\Files\Cache\Scanner', 'removeFromCache', [$path]);
+        if ($this->cacheActive) {
+            $this->cache->remove($path);
+        }
+    }
+
+    /**
+     * @param string $path
+     * @param array $data
+     * @param int $fileId
+     * @return int the id of the added file
+     */
+    protected function addToCache($path, $data, $fileId = -1) {
+        if (isset($data['scan_permissions'])) {
+            $data['permissions'] = $data['scan_permissions'];
+        }
+        \OC_Hook::emit('Scanner', 'addToCache', ['file' => $path, 'data' => $data]);
+        $this->emit('\OC\Files\Cache\Scanner', 'addToCache', [$path, $this->storageId, $data]);
+        if ($this->cacheActive) {
+            if ($fileId !== -1) {
+                $this->cache->update($fileId, $data);
+                return $fileId;
+            } else {
+                return $this->cache->insert($path, $data);
+            }
+        } else {
+            return -1;
+        }
+    }
+
+    /**
+     * @param string $path
+     * @param array $data
+     * @param int $fileId
+     */
+    protected function updateCache($path, $data, $fileId = -1) {
+        \OC_Hook::emit('Scanner', 'addToCache', ['file' => $path, 'data' => $data]);
+        $this->emit('\OC\Files\Cache\Scanner', 'updateCache', [$path, $this->storageId, $data]);
+        if ($this->cacheActive) {
+            if ($fileId !== -1) {
+                $this->cache->update($fileId, $data);
+            } else {
+                $this->cache->put($path, $data);
+            }
+        }
+    }
+
+    /**
+     * scan a folder and all it's children
+     *
+     * @param string $path
+     * @param bool $recursive
+     * @param int $reuse
+     * @param bool $lock set to false to disable getting an additional read lock during scanning
+     * @return array|null an array of the meta data of the scanned file or folder
+     */
+    public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $lock = true) {
+        if ($reuse === -1) {
+            $reuse = ($recursive === self::SCAN_SHALLOW) ? self::REUSE_ETAG | self::REUSE_SIZE : self::REUSE_ETAG;
+        }
+        if ($lock) {
+            if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+                $this->storage->acquireLock('scanner::' . $path, ILockingProvider::LOCK_EXCLUSIVE, $this->lockingProvider);
+                $this->storage->acquireLock($path, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
+            }
+        }
+        try {
+            $data = $this->scanFile($path, $reuse, -1, null, $lock);
+            if ($data and $data['mimetype'] === 'httpd/unix-directory') {
+                $size = $this->scanChildren($path, $recursive, $reuse, $data['fileid'], $lock);
+                $data['size'] = $size;
+            }
+        } finally {
+            if ($lock) {
+                if ($this->storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
+                    $this->storage->releaseLock($path, ILockingProvider::LOCK_SHARED, $this->lockingProvider);
+                    $this->storage->releaseLock('scanner::' . $path, ILockingProvider::LOCK_EXCLUSIVE, $this->lockingProvider);
+                }
+            }
+        }
+        return $data;
+    }
+
+    /**
+     * Get the children currently in the cache
+     *
+     * @param int $folderId
+     * @return array[]
+     */
+    protected function getExistingChildren($folderId) {
+        $existingChildren = [];
+        $children = $this->cache->getFolderContentsById($folderId);
+        foreach ($children as $child) {
+            $existingChildren[$child['name']] = $child;
+        }
+        return $existingChildren;
+    }
+
+    /**
+     * scan all the files and folders in a folder
+     *
+     * @param string $path
+     * @param bool $recursive
+     * @param int $reuse
+     * @param int $folderId id for the folder to be scanned
+     * @param bool $lock set to false to disable getting an additional read lock during scanning
+     * @return int the size of the scanned folder or -1 if the size is unknown at this stage
+     */
+    protected function scanChildren($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $folderId = null, $lock = true) {
+        if ($reuse === -1) {
+            $reuse = ($recursive === self::SCAN_SHALLOW) ? self::REUSE_ETAG | self::REUSE_SIZE : self::REUSE_ETAG;
+        }
+        $this->emit('\OC\Files\Cache\Scanner', 'scanFolder', [$path, $this->storageId]);
+        $size = 0;
+        if (!is_null($folderId)) {
+            $folderId = $this->cache->getId($path);
+        }
+        $childQueue = $this->handleChildren($path, $recursive, $reuse, $folderId, $lock, $size);
+
+        foreach ($childQueue as $child => $childId) {
+            $childSize = $this->scanChildren($child, $recursive, $reuse, $childId, $lock);
+            if ($childSize === -1) {
+                $size = -1;
+            } elseif ($size !== -1) {
+                $size += $childSize;
+            }
+        }
+        if ($this->cacheActive) {
+            $this->cache->update($folderId, ['size' => $size]);
+        }
+        $this->emit('\OC\Files\Cache\Scanner', 'postScanFolder', [$path, $this->storageId]);
+        return $size;
+    }
+
+    private function handleChildren($path, $recursive, $reuse, $folderId, $lock, &$size) {
+        // we put this in it's own function so it cleans up the memory before we start recursing
+        $existingChildren = $this->getExistingChildren($folderId);
+        $newChildren = iterator_to_array($this->storage->getDirectoryContent($path));
+
+        if ($this->useTransactions) {
+            \OC::$server->getDatabaseConnection()->beginTransaction();
+        }
+
+        $exceptionOccurred = false;
+        $childQueue = [];
+        $newChildNames = [];
+        foreach ($newChildren as $fileMeta) {
+            $permissions = isset($fileMeta['scan_permissions']) ? $fileMeta['scan_permissions'] : $fileMeta['permissions'];
+            if ($permissions === 0) {
+                continue;
+            }
+            $originalFile = $fileMeta['name'];
+            $file = trim(\OC\Files\Filesystem::normalizePath($originalFile), '/');
+            if (trim($originalFile, '/') !== $file) {
+                // encoding mismatch, might require compatibility wrapper
+                \OC::$server->getLogger()->debug('Scanner: Skipping non-normalized file name "'. $originalFile . '" in path "' . $path . '".', ['app' => 'core']);
+                $this->emit('\OC\Files\Cache\Scanner', 'normalizedNameMismatch', [$path ? $path . '/' . $originalFile : $originalFile]);
+                // skip this entry
+                continue;
+            }
+
+            $newChildNames[] = $file;
+            $child = $path ? $path . '/' . $file : $file;
+            try {
+                $existingData = isset($existingChildren[$file]) ? $existingChildren[$file] : false;
+                $data = $this->scanFile($child, $reuse, $folderId, $existingData, $lock, $fileMeta);
+                if ($data) {
+                    if ($data['mimetype'] === 'httpd/unix-directory' and $recursive === self::SCAN_RECURSIVE) {
+                        $childQueue[$child] = $data['fileid'];
+                    } elseif ($data['mimetype'] === 'httpd/unix-directory' and $recursive === self::SCAN_RECURSIVE_INCOMPLETE and $data['size'] === -1) {
+                        // only recurse into folders which aren't fully scanned
+                        $childQueue[$child] = $data['fileid'];
+                    } elseif ($data['size'] === -1) {
+                        $size = -1;
+                    } elseif ($size !== -1) {
+                        $size += $data['size'];
+                    }
+                }
+            } catch (Exception $ex) {
+                // might happen if inserting duplicate while a scanning
+                // process is running in parallel
+                // log and ignore
+                if ($this->useTransactions) {
+                    \OC::$server->getDatabaseConnection()->rollback();
+                    \OC::$server->getDatabaseConnection()->beginTransaction();
+                }
+                \OC::$server->getLogger()->logException($ex, [
+                    'message' => 'Exception while scanning file "' . $child . '"',
+                    'level' => ILogger::DEBUG,
+                    'app' => 'core',
+                ]);
+                $exceptionOccurred = true;
+            } catch (\OCP\Lock\LockedException $e) {
+                if ($this->useTransactions) {
+                    \OC::$server->getDatabaseConnection()->rollback();
+                }
+                throw $e;
+            }
+        }
+        $removedChildren = \array_diff(array_keys($existingChildren), $newChildNames);
+        foreach ($removedChildren as $childName) {
+            $child = $path ? $path . '/' . $childName : $childName;
+            $this->removeFromCache($child);
+        }
+        if ($this->useTransactions) {
+            \OC::$server->getDatabaseConnection()->commit();
+        }
+        if ($exceptionOccurred) {
+            // It might happen that the parallel scan process has already
+            // inserted mimetypes but those weren't available yet inside the transaction
+            // To make sure to have the updated mime types in such cases,
+            // we reload them here
+            \OC::$server->getMimeTypeLoader()->reset();
+        }
+        return $childQueue;
+    }
+
+    /**
+     * check if the file should be ignored when scanning
+     * NOTE: files with a '.part' extension are ignored as well!
+     *       prevents unfinished put requests to be scanned
+     *
+     * @param string $file
+     * @return boolean
+     */
+    public static function isPartialFile($file) {
+        if (pathinfo($file, PATHINFO_EXTENSION) === 'part') {
+            return true;
+        }
+        if (strpos($file, '.part/') !== false) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * walk over any folders that are not fully scanned yet and scan them
+     */
+    public function backgroundScan() {
+        if ($this->storage->instanceOfStorage(Jail::class)) {
+            // for jail storage wrappers (shares, groupfolders) we run the background scan on the source storage
+            // this is mainly done because the jail wrapper doesn't implement `getIncomplete` (because it would be inefficient).
+            //
+            // Running the scan on the source storage might scan more than "needed", but the unscanned files outside the jail will
+            // have to be scanned at some point anyway.
+            $unJailedScanner = $this->storage->getUnjailedStorage()->getScanner();
+            $unJailedScanner->backgroundScan();
+        } else {
+            if (!$this->cache->inCache('')) {
+                // if the storage isn't in the cache yet, just scan the root completely
+                $this->runBackgroundScanJob(function () {
+                    $this->scan('', self::SCAN_RECURSIVE, self::REUSE_ETAG);
+                }, '');
+            } else {
+                $lastPath = null;
+                // find any path marked as unscanned and run the scanner until no more paths are unscanned (or we get stuck)
+                while (($path = $this->cache->getIncomplete()) !== false && $path !== $lastPath) {
+                    $this->runBackgroundScanJob(function () use ($path) {
+                        $this->scan($path, self::SCAN_RECURSIVE_INCOMPLETE, self::REUSE_ETAG | self::REUSE_SIZE);
+                    }, $path);
+                    // FIXME: this won't proceed with the next item, needs revamping of getIncomplete()
+                    // to make this possible
+                    $lastPath = $path;
+                }
+            }
+        }
+    }
+
+    private function runBackgroundScanJob(callable $callback, $path) {
+        try {
+            $callback();
+            \OC_Hook::emit('Scanner', 'correctFolderSize', ['path' => $path]);
+            if ($this->cacheActive && $this->cache instanceof Cache) {
+                $this->cache->correctFolderSize($path, null, true);
+            }
+        } catch (\OCP\Files\StorageInvalidException $e) {
+            // skip unavailable storages
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            // skip unavailable storages
+        } catch (\OCP\Files\ForbiddenException $e) {
+            // skip forbidden storages
+        } catch (\OCP\Lock\LockedException $e) {
+            // skip unavailable storages
+        }
+    }
+
+    /**
+     * Set whether the cache is affected by scan operations
+     *
+     * @param boolean $active The active state of the cache
+     */
+    public function setCacheActive($active) {
+        $this->cacheActive = $active;
+    }
 }