nextcloud / server

apps/dav/lib/Connector/Sabre/Directory.php

Indentation +401 added lines, -401 removed lines

@@ -50,405 +50,405 @@
 use Sabre\DAV\INode;
 
 class Directory extends \OCA\DAV\Connector\Sabre\Node
-	implements \Sabre\DAV\ICollection, \Sabre\DAV\IQuota, \Sabre\DAV\IMoveTarget {
-
-	/**
-	 * Cached directory content
-	 *
-	 * @var \OCP\Files\FileInfo[]
-	 */
-	private $dirContent;
-
-	/**
-	 * Cached quota info
-	 *
-	 * @var array
-	 */
-	private $quotaInfo;
-
-	/**
-	 * @var ObjectTree|null
-	 */
-	private $tree;
-
-	/**
-	 * Sets up the node, expects a full path name
-	 *
-	 * @param \OC\Files\View $view
-	 * @param \OCP\Files\FileInfo $info
-	 * @param ObjectTree|null $tree
-	 * @param \OCP\Share\IManager $shareManager
-	 */
-	public function __construct(View $view, FileInfo $info, $tree = null, $shareManager = null) {
-		parent::__construct($view, $info, $shareManager);
-		$this->tree = $tree;
-	}
-
-	/**
-	 * Creates a new file in the directory
-	 *
-	 * Data will either be supplied as a stream resource, or in certain cases
-	 * as a string. Keep in mind that you may have to support either.
-	 *
-	 * After successful creation of the file, you may choose to return the ETag
-	 * of the new file here.
-	 *
-	 * The returned ETag must be surrounded by double-quotes (The quotes should
-	 * be part of the actual string).
-	 *
-	 * If you cannot accurately determine the ETag, you should not return it.
-	 * If you don't store the file exactly as-is (you're transforming it
-	 * somehow) you should also not return an ETag.
-	 *
-	 * This means that if a subsequent GET to this new file does not exactly
-	 * return the same contents of what was submitted here, you are strongly
-	 * recommended to omit the ETag.
-	 *
-	 * @param string $name Name of the file
-	 * @param resource|string $data Initial payload
-	 * @return null|string
-	 * @throws Exception\EntityTooLarge
-	 * @throws Exception\UnsupportedMediaType
-	 * @throws FileLocked
-	 * @throws InvalidPath
-	 * @throws \Sabre\DAV\Exception
-	 * @throws \Sabre\DAV\Exception\BadRequest
-	 * @throws \Sabre\DAV\Exception\Forbidden
-	 * @throws \Sabre\DAV\Exception\ServiceUnavailable
-	 */
-	public function createFile($name, $data = null) {
-
-		try {
-			// for chunked upload also updating a existing file is a "createFile"
-			// because we create all the chunks before re-assemble them to the existing file.
-			if (isset($_SERVER['HTTP_OC_CHUNKED'])) {
-
-				// exit if we can't create a new file and we don't updatable existing file
-				$chunkInfo = \OC_FileChunking::decodeName($name);
-				if (!$this->fileView->isCreatable($this->path) &&
-					!$this->fileView->isUpdatable($this->path . '/' . $chunkInfo['name'])
-				) {
-					throw new \Sabre\DAV\Exception\Forbidden();
-				}
-
-			} else {
-				// For non-chunked upload it is enough to check if we can create a new file
-				if (!$this->fileView->isCreatable($this->path)) {
-					throw new \Sabre\DAV\Exception\Forbidden();
-				}
-			}
-
-			$this->fileView->verifyPath($this->path, $name);
-
-			$path = $this->fileView->getAbsolutePath($this->path) . '/' . $name;
-			// in case the file already exists/overwriting
-			$info = $this->fileView->getFileInfo($this->path . '/' . $name);
-			if (!$info) {
-				// use a dummy FileInfo which is acceptable here since it will be refreshed after the put is complete
-				$info = new \OC\Files\FileInfo($path, null, null, [], null);
-			}
-			$node = new \OCA\DAV\Connector\Sabre\File($this->fileView, $info);
-
-			// only allow 1 process to upload a file at once but still allow reading the file while writing the part file
-			$node->acquireLock(ILockingProvider::LOCK_SHARED);
-			$this->fileView->lockFile($path . '.upload.part', ILockingProvider::LOCK_EXCLUSIVE);
-
-			$result = $node->put($data);
-
-			$this->fileView->unlockFile($path . '.upload.part', ILockingProvider::LOCK_EXCLUSIVE);
-			$node->releaseLock(ILockingProvider::LOCK_SHARED);
-			return $result;
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			throw new \Sabre\DAV\Exception\ServiceUnavailable($e->getMessage(), $e->getCode(), $e);
-		} catch (InvalidPathException $ex) {
-			throw new InvalidPath($ex->getMessage(), false, $ex);
-		} catch (ForbiddenException $ex) {
-			throw new Forbidden($ex->getMessage(), $ex->getRetry(), $ex);
-		} catch (LockedException $e) {
-			throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	/**
-	 * Creates a new subdirectory
-	 *
-	 * @param string $name
-	 * @throws FileLocked
-	 * @throws InvalidPath
-	 * @throws \Sabre\DAV\Exception\Forbidden
-	 * @throws \Sabre\DAV\Exception\ServiceUnavailable
-	 */
-	public function createDirectory($name) {
-		try {
-			if (!$this->info->isCreatable()) {
-				throw new \Sabre\DAV\Exception\Forbidden();
-			}
-
-			$this->fileView->verifyPath($this->path, $name);
-			$newPath = $this->path . '/' . $name;
-			if (!$this->fileView->mkdir($newPath)) {
-				throw new \Sabre\DAV\Exception\Forbidden('Could not create directory ' . $newPath);
-			}
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			throw new \Sabre\DAV\Exception\ServiceUnavailable($e->getMessage());
-		} catch (InvalidPathException $ex) {
-			throw new InvalidPath($ex->getMessage());
-		} catch (ForbiddenException $ex) {
-			throw new Forbidden($ex->getMessage(), $ex->getRetry());
-		} catch (LockedException $e) {
-			throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	/**
-	 * Returns a specific child node, referenced by its name
-	 *
-	 * @param string $name
-	 * @param \OCP\Files\FileInfo $info
-	 * @return \Sabre\DAV\INode
-	 * @throws InvalidPath
-	 * @throws \Sabre\DAV\Exception\NotFound
-	 * @throws \Sabre\DAV\Exception\ServiceUnavailable
-	 */
-	public function getChild($name, $info = null) {
-		if (!$this->info->isReadable()) {
-			// avoid detecting files through this way
-			throw new NotFound();
-		}
-
-		$path = $this->path . '/' . $name;
-		if (is_null($info)) {
-			try {
-				$this->fileView->verifyPath($this->path, $name);
-				$info = $this->fileView->getFileInfo($path);
-			} catch (\OCP\Files\StorageNotAvailableException $e) {
-				throw new \Sabre\DAV\Exception\ServiceUnavailable($e->getMessage());
-			} catch (InvalidPathException $ex) {
-				throw new InvalidPath($ex->getMessage());
-			} catch (ForbiddenException $e) {
-				throw new \Sabre\DAV\Exception\Forbidden();
-			}
-		}
-
-		if (!$info) {
-			throw new \Sabre\DAV\Exception\NotFound('File with name ' . $path . ' could not be located');
-		}
-
-		if ($info['mimetype'] === 'httpd/unix-directory') {
-			$node = new \OCA\DAV\Connector\Sabre\Directory($this->fileView, $info, $this->tree, $this->shareManager);
-		} else {
-			$node = new \OCA\DAV\Connector\Sabre\File($this->fileView, $info, $this->shareManager);
-		}
-		if ($this->tree) {
-			$this->tree->cacheNode($node);
-		}
-		return $node;
-	}
-
-	/**
-	 * Returns an array with all the child nodes
-	 *
-	 * @return \Sabre\DAV\INode[]
-	 * @throws \Sabre\DAV\Exception\Locked
-	 * @throws \OCA\DAV\Connector\Sabre\Exception\Forbidden
-	 */
-	public function getChildren() {
-		if (!is_null($this->dirContent)) {
-			return $this->dirContent;
-		}
-		try {
-			if (!$this->info->isReadable()) {
-				// return 403 instead of 404 because a 404 would make
-				// the caller believe that the collection itself does not exist
-				throw new Forbidden('No read permissions');
-			}
-			$folderContent = $this->fileView->getDirectoryContent($this->path);
-		} catch (LockedException $e) {
-			throw new Locked();
-		}
-
-		$nodes = [];
-		foreach ($folderContent as $info) {
-			$node = $this->getChild($info->getName(), $info);
-			$nodes[] = $node;
-		}
-		$this->dirContent = $nodes;
-		return $this->dirContent;
-	}
-
-	/**
-	 * Checks if a child exists.
-	 *
-	 * @param string $name
-	 * @return bool
-	 */
-	public function childExists($name) {
-		// note: here we do NOT resolve the chunk file name to the real file name
-		// to make sure we return false when checking for file existence with a chunk
-		// file name.
-		// This is to make sure that "createFile" is still triggered
-		// (required old code) instead of "updateFile".
-		//
-		// TODO: resolve chunk file name here and implement "updateFile"
-		$path = $this->path . '/' . $name;
-		return $this->fileView->file_exists($path);
-
-	}
-
-	/**
-	 * Deletes all files in this directory, and then itself
-	 *
-	 * @return void
-	 * @throws FileLocked
-	 * @throws \Sabre\DAV\Exception\Forbidden
-	 */
-	public function delete() {
-
-		if ($this->path === '' || $this->path === '/' || !$this->info->isDeletable()) {
-			throw new \Sabre\DAV\Exception\Forbidden();
-		}
-
-		try {
-			if (!$this->fileView->rmdir($this->path)) {
-				// assume it wasn't possible to remove due to permission issue
-				throw new \Sabre\DAV\Exception\Forbidden();
-			}
-		} catch (ForbiddenException $ex) {
-			throw new Forbidden($ex->getMessage(), $ex->getRetry());
-		} catch (LockedException $e) {
-			throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	/**
-	 * Returns available diskspace information
-	 *
-	 * @return array
-	 */
-	public function getQuotaInfo() {
-		if ($this->quotaInfo) {
-			return $this->quotaInfo;
-		}
-		try {
-			$storageInfo = \OC_Helper::getStorageInfo($this->info->getPath(), $this->info);
-			if ($storageInfo['quota'] === \OCP\Files\FileInfo::SPACE_UNLIMITED) {
-				$free = \OCP\Files\FileInfo::SPACE_UNLIMITED;
-			} else {
-				$free = $storageInfo['free'];
-			}
-			$this->quotaInfo = [
-				$storageInfo['used'],
-				$free
-			];
-			return $this->quotaInfo;
-		} catch (\OCP\Files\StorageNotAvailableException $e) {
-			return [0, 0];
-		}
-	}
-
-	/**
-	 * Moves a node into this collection.
-	 *
-	 * It is up to the implementors to:
-	 *   1. Create the new resource.
-	 *   2. Remove the old resource.
-	 *   3. Transfer any properties or other data.
-	 *
-	 * Generally you should make very sure that your collection can easily move
-	 * the move.
-	 *
-	 * If you don't, just return false, which will trigger sabre/dav to handle
-	 * the move itself. If you return true from this function, the assumption
-	 * is that the move was successful.
-	 *
-	 * @param string $targetName New local file/collection name.
-	 * @param string $fullSourcePath Full path to source node
-	 * @param INode $sourceNode Source node itself
-	 * @return bool
-	 * @throws BadRequest
-	 * @throws ServiceUnavailable
-	 * @throws Forbidden
-	 * @throws FileLocked
-	 * @throws \Sabre\DAV\Exception\Forbidden
-	 */
-	public function moveInto($targetName, $fullSourcePath, INode $sourceNode) {
-		if (!$sourceNode instanceof Node) {
-			// it's a file of another kind, like FutureFile
-			if ($sourceNode instanceof IFile) {
-				// fallback to default copy+delete handling
-				return false;
-			}
-			throw new BadRequest('Incompatible node types');
-		}
-
-		if (!$this->fileView) {
-			throw new ServiceUnavailable('filesystem not setup');
-		}
-
-		$destinationPath = $this->getPath() . '/' . $targetName;
-
-
-		$targetNodeExists = $this->childExists($targetName);
-
-		// at getNodeForPath we also check the path for isForbiddenFileOrDir
-		// with that we have covered both source and destination
-		if ($sourceNode instanceof Directory && $targetNodeExists) {
-			throw new \Sabre\DAV\Exception\Forbidden('Could not copy directory ' . $sourceNode->getName() . ', target exists');
-		}
-
-		list($sourceDir,) = \Sabre\Uri\split($sourceNode->getPath());
-		$destinationDir = $this->getPath();
-
-		$sourcePath = $sourceNode->getPath();
-
-		$isMovableMount = false;
-		$sourceMount = \OC::$server->getMountManager()->find($this->fileView->getAbsolutePath($sourcePath));
-		$internalPath = $sourceMount->getInternalPath($this->fileView->getAbsolutePath($sourcePath));
-		if ($sourceMount instanceof MoveableMount && $internalPath === '') {
-			$isMovableMount = true;
-		}
-
-		try {
-			$sameFolder = ($sourceDir === $destinationDir);
-			// if we're overwriting or same folder
-			if ($targetNodeExists || $sameFolder) {
-				// note that renaming a share mount point is always allowed
-				if (!$this->fileView->isUpdatable($destinationDir) && !$isMovableMount) {
-					throw new \Sabre\DAV\Exception\Forbidden();
-				}
-			} else {
-				if (!$this->fileView->isCreatable($destinationDir)) {
-					throw new \Sabre\DAV\Exception\Forbidden();
-				}
-			}
-
-			if (!$sameFolder) {
-				// moving to a different folder, source will be gone, like a deletion
-				// note that moving a share mount point is always allowed
-				if (!$this->fileView->isDeletable($sourcePath) && !$isMovableMount) {
-					throw new \Sabre\DAV\Exception\Forbidden();
-				}
-			}
-
-			$fileName = basename($destinationPath);
-			try {
-				$this->fileView->verifyPath($destinationDir, $fileName);
-			} catch (InvalidPathException $ex) {
-				throw new InvalidPath($ex->getMessage());
-			}
-
-			$renameOkay = $this->fileView->rename($sourcePath, $destinationPath);
-			if (!$renameOkay) {
-				throw new \Sabre\DAV\Exception\Forbidden('');
-			}
-		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable($e->getMessage());
-		} catch (ForbiddenException $ex) {
-			throw new Forbidden($ex->getMessage(), $ex->getRetry());
-		} catch (LockedException $e) {
-			throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-		}
-
-		return true;
-	}
+    implements \Sabre\DAV\ICollection, \Sabre\DAV\IQuota, \Sabre\DAV\IMoveTarget {
+
+    /**
+     * Cached directory content
+     *
+     * @var \OCP\Files\FileInfo[]
+     */
+    private $dirContent;
+
+    /**
+     * Cached quota info
+     *
+     * @var array
+     */
+    private $quotaInfo;
+
+    /**
+     * @var ObjectTree|null
+     */
+    private $tree;
+
+    /**
+     * Sets up the node, expects a full path name
+     *
+     * @param \OC\Files\View $view
+     * @param \OCP\Files\FileInfo $info
+     * @param ObjectTree|null $tree
+     * @param \OCP\Share\IManager $shareManager
+     */
+    public function __construct(View $view, FileInfo $info, $tree = null, $shareManager = null) {
+        parent::__construct($view, $info, $shareManager);
+        $this->tree = $tree;
+    }
+
+    /**
+     * Creates a new file in the directory
+     *
+     * Data will either be supplied as a stream resource, or in certain cases
+     * as a string. Keep in mind that you may have to support either.
+     *
+     * After successful creation of the file, you may choose to return the ETag
+     * of the new file here.
+     *
+     * The returned ETag must be surrounded by double-quotes (The quotes should
+     * be part of the actual string).
+     *
+     * If you cannot accurately determine the ETag, you should not return it.
+     * If you don't store the file exactly as-is (you're transforming it
+     * somehow) you should also not return an ETag.
+     *
+     * This means that if a subsequent GET to this new file does not exactly
+     * return the same contents of what was submitted here, you are strongly
+     * recommended to omit the ETag.
+     *
+     * @param string $name Name of the file
+     * @param resource|string $data Initial payload
+     * @return null|string
+     * @throws Exception\EntityTooLarge
+     * @throws Exception\UnsupportedMediaType
+     * @throws FileLocked
+     * @throws InvalidPath
+     * @throws \Sabre\DAV\Exception
+     * @throws \Sabre\DAV\Exception\BadRequest
+     * @throws \Sabre\DAV\Exception\Forbidden
+     * @throws \Sabre\DAV\Exception\ServiceUnavailable
+     */
+    public function createFile($name, $data = null) {
+
+        try {
+            // for chunked upload also updating a existing file is a "createFile"
+            // because we create all the chunks before re-assemble them to the existing file.
+            if (isset($_SERVER['HTTP_OC_CHUNKED'])) {
+
+                // exit if we can't create a new file and we don't updatable existing file
+                $chunkInfo = \OC_FileChunking::decodeName($name);
+                if (!$this->fileView->isCreatable($this->path) &&
+                    !$this->fileView->isUpdatable($this->path . '/' . $chunkInfo['name'])
+                ) {
+                    throw new \Sabre\DAV\Exception\Forbidden();
+                }
+
+            } else {
+                // For non-chunked upload it is enough to check if we can create a new file
+                if (!$this->fileView->isCreatable($this->path)) {
+                    throw new \Sabre\DAV\Exception\Forbidden();
+                }
+            }
+
+            $this->fileView->verifyPath($this->path, $name);
+
+            $path = $this->fileView->getAbsolutePath($this->path) . '/' . $name;
+            // in case the file already exists/overwriting
+            $info = $this->fileView->getFileInfo($this->path . '/' . $name);
+            if (!$info) {
+                // use a dummy FileInfo which is acceptable here since it will be refreshed after the put is complete
+                $info = new \OC\Files\FileInfo($path, null, null, [], null);
+            }
+            $node = new \OCA\DAV\Connector\Sabre\File($this->fileView, $info);
+
+            // only allow 1 process to upload a file at once but still allow reading the file while writing the part file
+            $node->acquireLock(ILockingProvider::LOCK_SHARED);
+            $this->fileView->lockFile($path . '.upload.part', ILockingProvider::LOCK_EXCLUSIVE);
+
+            $result = $node->put($data);
+
+            $this->fileView->unlockFile($path . '.upload.part', ILockingProvider::LOCK_EXCLUSIVE);
+            $node->releaseLock(ILockingProvider::LOCK_SHARED);
+            return $result;
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            throw new \Sabre\DAV\Exception\ServiceUnavailable($e->getMessage(), $e->getCode(), $e);
+        } catch (InvalidPathException $ex) {
+            throw new InvalidPath($ex->getMessage(), false, $ex);
+        } catch (ForbiddenException $ex) {
+            throw new Forbidden($ex->getMessage(), $ex->getRetry(), $ex);
+        } catch (LockedException $e) {
+            throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    /**
+     * Creates a new subdirectory
+     *
+     * @param string $name
+     * @throws FileLocked
+     * @throws InvalidPath
+     * @throws \Sabre\DAV\Exception\Forbidden
+     * @throws \Sabre\DAV\Exception\ServiceUnavailable
+     */
+    public function createDirectory($name) {
+        try {
+            if (!$this->info->isCreatable()) {
+                throw new \Sabre\DAV\Exception\Forbidden();
+            }
+
+            $this->fileView->verifyPath($this->path, $name);
+            $newPath = $this->path . '/' . $name;
+            if (!$this->fileView->mkdir($newPath)) {
+                throw new \Sabre\DAV\Exception\Forbidden('Could not create directory ' . $newPath);
+            }
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            throw new \Sabre\DAV\Exception\ServiceUnavailable($e->getMessage());
+        } catch (InvalidPathException $ex) {
+            throw new InvalidPath($ex->getMessage());
+        } catch (ForbiddenException $ex) {
+            throw new Forbidden($ex->getMessage(), $ex->getRetry());
+        } catch (LockedException $e) {
+            throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    /**
+     * Returns a specific child node, referenced by its name
+     *
+     * @param string $name
+     * @param \OCP\Files\FileInfo $info
+     * @return \Sabre\DAV\INode
+     * @throws InvalidPath
+     * @throws \Sabre\DAV\Exception\NotFound
+     * @throws \Sabre\DAV\Exception\ServiceUnavailable
+     */
+    public function getChild($name, $info = null) {
+        if (!$this->info->isReadable()) {
+            // avoid detecting files through this way
+            throw new NotFound();
+        }
+
+        $path = $this->path . '/' . $name;
+        if (is_null($info)) {
+            try {
+                $this->fileView->verifyPath($this->path, $name);
+                $info = $this->fileView->getFileInfo($path);
+            } catch (\OCP\Files\StorageNotAvailableException $e) {
+                throw new \Sabre\DAV\Exception\ServiceUnavailable($e->getMessage());
+            } catch (InvalidPathException $ex) {
+                throw new InvalidPath($ex->getMessage());
+            } catch (ForbiddenException $e) {
+                throw new \Sabre\DAV\Exception\Forbidden();
+            }
+        }
+
+        if (!$info) {
+            throw new \Sabre\DAV\Exception\NotFound('File with name ' . $path . ' could not be located');
+        }
+
+        if ($info['mimetype'] === 'httpd/unix-directory') {
+            $node = new \OCA\DAV\Connector\Sabre\Directory($this->fileView, $info, $this->tree, $this->shareManager);
+        } else {
+            $node = new \OCA\DAV\Connector\Sabre\File($this->fileView, $info, $this->shareManager);
+        }
+        if ($this->tree) {
+            $this->tree->cacheNode($node);
+        }
+        return $node;
+    }
+
+    /**
+     * Returns an array with all the child nodes
+     *
+     * @return \Sabre\DAV\INode[]
+     * @throws \Sabre\DAV\Exception\Locked
+     * @throws \OCA\DAV\Connector\Sabre\Exception\Forbidden
+     */
+    public function getChildren() {
+        if (!is_null($this->dirContent)) {
+            return $this->dirContent;
+        }
+        try {
+            if (!$this->info->isReadable()) {
+                // return 403 instead of 404 because a 404 would make
+                // the caller believe that the collection itself does not exist
+                throw new Forbidden('No read permissions');
+            }
+            $folderContent = $this->fileView->getDirectoryContent($this->path);
+        } catch (LockedException $e) {
+            throw new Locked();
+        }
+
+        $nodes = [];
+        foreach ($folderContent as $info) {
+            $node = $this->getChild($info->getName(), $info);
+            $nodes[] = $node;
+        }
+        $this->dirContent = $nodes;
+        return $this->dirContent;
+    }
+
+    /**
+     * Checks if a child exists.
+     *
+     * @param string $name
+     * @return bool
+     */
+    public function childExists($name) {
+        // note: here we do NOT resolve the chunk file name to the real file name
+        // to make sure we return false when checking for file existence with a chunk
+        // file name.
+        // This is to make sure that "createFile" is still triggered
+        // (required old code) instead of "updateFile".
+        //
+        // TODO: resolve chunk file name here and implement "updateFile"
+        $path = $this->path . '/' . $name;
+        return $this->fileView->file_exists($path);
+
+    }
+
+    /**
+     * Deletes all files in this directory, and then itself
+     *
+     * @return void
+     * @throws FileLocked
+     * @throws \Sabre\DAV\Exception\Forbidden
+     */
+    public function delete() {
+
+        if ($this->path === '' || $this->path === '/' || !$this->info->isDeletable()) {
+            throw new \Sabre\DAV\Exception\Forbidden();
+        }
+
+        try {
+            if (!$this->fileView->rmdir($this->path)) {
+                // assume it wasn't possible to remove due to permission issue
+                throw new \Sabre\DAV\Exception\Forbidden();
+            }
+        } catch (ForbiddenException $ex) {
+            throw new Forbidden($ex->getMessage(), $ex->getRetry());
+        } catch (LockedException $e) {
+            throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    /**
+     * Returns available diskspace information
+     *
+     * @return array
+     */
+    public function getQuotaInfo() {
+        if ($this->quotaInfo) {
+            return $this->quotaInfo;
+        }
+        try {
+            $storageInfo = \OC_Helper::getStorageInfo($this->info->getPath(), $this->info);
+            if ($storageInfo['quota'] === \OCP\Files\FileInfo::SPACE_UNLIMITED) {
+                $free = \OCP\Files\FileInfo::SPACE_UNLIMITED;
+            } else {
+                $free = $storageInfo['free'];
+            }
+            $this->quotaInfo = [
+                $storageInfo['used'],
+                $free
+            ];
+            return $this->quotaInfo;
+        } catch (\OCP\Files\StorageNotAvailableException $e) {
+            return [0, 0];
+        }
+    }
+
+    /**
+     * Moves a node into this collection.
+     *
+     * It is up to the implementors to:
+     *   1. Create the new resource.
+     *   2. Remove the old resource.
+     *   3. Transfer any properties or other data.
+     *
+     * Generally you should make very sure that your collection can easily move
+     * the move.
+     *
+     * If you don't, just return false, which will trigger sabre/dav to handle
+     * the move itself. If you return true from this function, the assumption
+     * is that the move was successful.
+     *
+     * @param string $targetName New local file/collection name.
+     * @param string $fullSourcePath Full path to source node
+     * @param INode $sourceNode Source node itself
+     * @return bool
+     * @throws BadRequest
+     * @throws ServiceUnavailable
+     * @throws Forbidden
+     * @throws FileLocked
+     * @throws \Sabre\DAV\Exception\Forbidden
+     */
+    public function moveInto($targetName, $fullSourcePath, INode $sourceNode) {
+        if (!$sourceNode instanceof Node) {
+            // it's a file of another kind, like FutureFile
+            if ($sourceNode instanceof IFile) {
+                // fallback to default copy+delete handling
+                return false;
+            }
+            throw new BadRequest('Incompatible node types');
+        }
+
+        if (!$this->fileView) {
+            throw new ServiceUnavailable('filesystem not setup');
+        }
+
+        $destinationPath = $this->getPath() . '/' . $targetName;
+
+
+        $targetNodeExists = $this->childExists($targetName);
+
+        // at getNodeForPath we also check the path for isForbiddenFileOrDir
+        // with that we have covered both source and destination
+        if ($sourceNode instanceof Directory && $targetNodeExists) {
+            throw new \Sabre\DAV\Exception\Forbidden('Could not copy directory ' . $sourceNode->getName() . ', target exists');
+        }
+
+        list($sourceDir,) = \Sabre\Uri\split($sourceNode->getPath());
+        $destinationDir = $this->getPath();
+
+        $sourcePath = $sourceNode->getPath();
+
+        $isMovableMount = false;
+        $sourceMount = \OC::$server->getMountManager()->find($this->fileView->getAbsolutePath($sourcePath));
+        $internalPath = $sourceMount->getInternalPath($this->fileView->getAbsolutePath($sourcePath));
+        if ($sourceMount instanceof MoveableMount && $internalPath === '') {
+            $isMovableMount = true;
+        }
+
+        try {
+            $sameFolder = ($sourceDir === $destinationDir);
+            // if we're overwriting or same folder
+            if ($targetNodeExists || $sameFolder) {
+                // note that renaming a share mount point is always allowed
+                if (!$this->fileView->isUpdatable($destinationDir) && !$isMovableMount) {
+                    throw new \Sabre\DAV\Exception\Forbidden();
+                }
+            } else {
+                if (!$this->fileView->isCreatable($destinationDir)) {
+                    throw new \Sabre\DAV\Exception\Forbidden();
+                }
+            }
+
+            if (!$sameFolder) {
+                // moving to a different folder, source will be gone, like a deletion
+                // note that moving a share mount point is always allowed
+                if (!$this->fileView->isDeletable($sourcePath) && !$isMovableMount) {
+                    throw new \Sabre\DAV\Exception\Forbidden();
+                }
+            }
+
+            $fileName = basename($destinationPath);
+            try {
+                $this->fileView->verifyPath($destinationDir, $fileName);
+            } catch (InvalidPathException $ex) {
+                throw new InvalidPath($ex->getMessage());
+            }
+
+            $renameOkay = $this->fileView->rename($sourcePath, $destinationPath);
+            if (!$renameOkay) {
+                throw new \Sabre\DAV\Exception\Forbidden('');
+            }
+        } catch (StorageNotAvailableException $e) {
+            throw new ServiceUnavailable($e->getMessage());
+        } catch (ForbiddenException $ex) {
+            throw new Forbidden($ex->getMessage(), $ex->getRetry());
+        } catch (LockedException $e) {
+            throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+        }
+
+        return true;
+    }
 }

apps/dav/lib/Connector/Sabre/File.php

Indentation +601 added lines, -601 removed lines

@@ -70,605 +70,605 @@
 
 class File extends Node implements IFile {
 
-	protected $request;
-
-	/**
-	 * Sets up the node, expects a full path name
-	 *
-	 * @param \OC\Files\View $view
-	 * @param \OCP\Files\FileInfo $info
-	 * @param \OCP\Share\IManager $shareManager
-	 * @param \OC\AppFramework\Http\Request $request
-	 */
-	public function __construct(View $view, FileInfo $info, IManager $shareManager = null, Request $request = null) {
-		parent::__construct($view, $info, $shareManager);
-
-		if (isset($request)) {
-			$this->request = $request;
-		} else {
-			$this->request = \OC::$server->getRequest();
-		}
-	}
-
-	/**
-	 * Updates the data
-	 *
-	 * The data argument is a readable stream resource.
-	 *
-	 * After a successful put operation, you may choose to return an ETag. The
-	 * etag must always be surrounded by double-quotes. These quotes must
-	 * appear in the actual string you're returning.
-	 *
-	 * Clients may use the ETag from a PUT request to later on make sure that
-	 * when they update the file, the contents haven't changed in the mean
-	 * time.
-	 *
-	 * If you don't plan to store the file byte-by-byte, and you return a
-	 * different object on a subsequent GET you are strongly recommended to not
-	 * return an ETag, and just return null.
-	 *
-	 * @param resource $data
-	 *
-	 * @throws Forbidden
-	 * @throws UnsupportedMediaType
-	 * @throws BadRequest
-	 * @throws Exception
-	 * @throws EntityTooLarge
-	 * @throws ServiceUnavailable
-	 * @throws FileLocked
-	 * @return string|null
-	 */
-	public function put($data) {
-		try {
-			$exists = $this->fileView->file_exists($this->path);
-			if ($this->info && $exists && !$this->info->isUpdateable()) {
-				throw new Forbidden();
-			}
-		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("File is not updatable: " . $e->getMessage());
-		}
-
-		// verify path of the target
-		$this->verifyPath();
-
-		// chunked handling
-		if (isset($_SERVER['HTTP_OC_CHUNKED'])) {
-			try {
-				return $this->createFileChunked($data);
-			} catch (\Exception $e) {
-				$this->convertToSabreException($e);
-			}
-		}
-
-		/** @var Storage $partStorage */
-		list($partStorage) = $this->fileView->resolvePath($this->path);
-		$needsPartFile = $partStorage->needsPartFile() && (strlen($this->path) > 1);
-
-		$view = \OC\Files\Filesystem::getView();
-
-		if ($needsPartFile) {
-			// mark file as partial while uploading (ignored by the scanner)
-			$partFilePath = $this->getPartFileBasePath($this->path) . '.ocTransferId' . rand() . '.part';
-
-			if (!$view->isCreatable($partFilePath) && $view->isUpdatable($this->path)) {
-				$needsPartFile = false;
-			}
-		}
-		if (!$needsPartFile) {
-			// upload file directly as the final path
-			$partFilePath = $this->path;
-
-			if ($view && !$this->emitPreHooks($exists)) {
-				throw new Exception('Could not write to final file, canceled by hook');
-			}
-		}
-
-		// the part file and target file might be on a different storage in case of a single file storage (e.g. single file share)
-		/** @var \OC\Files\Storage\Storage $partStorage */
-		list($partStorage, $internalPartPath) = $this->fileView->resolvePath($partFilePath);
-		/** @var \OC\Files\Storage\Storage $storage */
-		list($storage, $internalPath) = $this->fileView->resolvePath($this->path);
-		try {
-			if (!$needsPartFile) {
-				$this->changeLock(ILockingProvider::LOCK_EXCLUSIVE);
-			}
-
-			if ($partStorage->instanceOfStorage(Storage\IWriteStreamStorage::class)) {
-
-				if (!is_resource($data)) {
-					$tmpData = fopen('php://temp', 'r+');
-					if ($data !== null) {
-						fwrite($tmpData, $data);
-						rewind($tmpData);
-					}
-					$data = $tmpData;
-				}
-
-				$isEOF = false;
-				$wrappedData = CallbackWrapper::wrap($data, null, null, null, null, function ($stream) use (&$isEOF) {
-					$isEOF = feof($stream);
-				});
-
-				$count = $partStorage->writeStream($internalPartPath, $wrappedData);
-				$result = $count > 0;
-
-				if ($result === false) {
-					$result = $isEOF;
-					if (is_resource($wrappedData)) {
-						$result = feof($wrappedData);
-					}
-				}
-
-			} else {
-				$target = $partStorage->fopen($internalPartPath, 'wb');
-				if ($target === false) {
-					\OC::$server->getLogger()->error('\OC\Files\Filesystem::fopen() failed', ['app' => 'webdav']);
-					// because we have no clue about the cause we can only throw back a 500/Internal Server Error
-					throw new Exception('Could not write file contents');
-				}
-				list($count, $result) = \OC_Helper::streamCopy($data, $target);
-				fclose($target);
-			}
-
-			if ($result === false) {
-				$expected = -1;
-				if (isset($_SERVER['CONTENT_LENGTH'])) {
-					$expected = $_SERVER['CONTENT_LENGTH'];
-				}
-				if ($expected !== "0") {
-					throw new Exception('Error while copying file to target location (copied bytes: ' . $count . ', expected filesize: ' . $expected . ' )');
-				}
-			}
-
-			// if content length is sent by client:
-			// double check if the file was fully received
-			// compare expected and actual size
-			if (isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['REQUEST_METHOD'] === 'PUT') {
-				$expected = (int)$_SERVER['CONTENT_LENGTH'];
-				if ($count !== $expected) {
-					throw new BadRequest('Expected filesize of ' . $expected . ' bytes but read (from Nextcloud client) and wrote (to Nextcloud storage) ' . $count . ' bytes. Could either be a network problem on the sending side or a problem writing to the storage on the server side.');
-				}
-			}
-
-		} catch (\Exception $e) {
-			$context = [];
-
-			if ($e instanceof LockedException) {
-				$context['level'] = ILogger::DEBUG;
-			}
-
-			\OC::$server->getLogger()->logException($e, $context);
-			if ($needsPartFile) {
-				$partStorage->unlink($internalPartPath);
-			}
-			$this->convertToSabreException($e);
-		}
-
-		try {
-			if ($needsPartFile) {
-				if ($view && !$this->emitPreHooks($exists)) {
-					$partStorage->unlink($internalPartPath);
-					throw new Exception('Could not rename part file to final file, canceled by hook');
-				}
-				try {
-					$this->changeLock(ILockingProvider::LOCK_EXCLUSIVE);
-				} catch (LockedException $e) {
-					// during very large uploads, the shared lock we got at the start might have been expired
-					// meaning that the above lock can fail not just only because somebody else got a shared lock
-					// or because there is no existing shared lock to make exclusive
-					//
-					// Thus we try to get a new exclusive lock, if the original lock failed because of a different shared
-					// lock this will still fail, if our original shared lock expired the new lock will be successful and
-					// the entire operation will be safe
-
-					try {
-						$this->acquireLock(ILockingProvider::LOCK_EXCLUSIVE);
-					} catch (LockedException $ex) {
-						if ($needsPartFile) {
-							$partStorage->unlink($internalPartPath);
-						}
-						throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-					}
-				}
-
-				// rename to correct path
-				try {
-					$renameOkay = $storage->moveFromStorage($partStorage, $internalPartPath, $internalPath);
-					$fileExists = $storage->file_exists($internalPath);
-					if ($renameOkay === false || $fileExists === false) {
-						\OC::$server->getLogger()->error('renaming part file to final file failed $renameOkay: ' . ($renameOkay ? 'true' : 'false') . ', $fileExists: ' . ($fileExists ? 'true' : 'false') . ')', ['app' => 'webdav']);
-						throw new Exception('Could not rename part file to final file');
-					}
-				} catch (ForbiddenException $ex) {
-					throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
-				} catch (\Exception $e) {
-					$partStorage->unlink($internalPartPath);
-					$this->convertToSabreException($e);
-				}
-			}
-
-			// since we skipped the view we need to scan and emit the hooks ourselves
-			$storage->getUpdater()->update($internalPath);
-
-			try {
-				$this->changeLock(ILockingProvider::LOCK_SHARED);
-			} catch (LockedException $e) {
-				throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-			}
-
-			// allow sync clients to send the mtime along in a header
-			if (isset($this->request->server['HTTP_X_OC_MTIME'])) {
-				$mtime = $this->sanitizeMtime($this->request->server['HTTP_X_OC_MTIME']);
-				if ($this->fileView->touch($this->path, $mtime)) {
-					$this->header('X-OC-MTime: accepted');
-				}
-			}
-
-			$fileInfoUpdate = [
-				'upload_time' => time()
-			];
-
-			// allow sync clients to send the creation time along in a header
-			if (isset($this->request->server['HTTP_X_OC_CTIME'])) {
-				$ctime = $this->sanitizeMtime($this->request->server['HTTP_X_OC_CTIME']);
-				$fileInfoUpdate['creation_time'] = $ctime;
-				$this->header('X-OC-CTime: accepted');
-			}
-
-			$this->fileView->putFileInfo($this->path, $fileInfoUpdate);
-
-			if ($view) {
-				$this->emitPostHooks($exists);
-			}
-
-			$this->refreshInfo();
-
-			if (isset($this->request->server['HTTP_OC_CHECKSUM'])) {
-				$checksum = trim($this->request->server['HTTP_OC_CHECKSUM']);
-				$this->fileView->putFileInfo($this->path, ['checksum' => $checksum]);
-				$this->refreshInfo();
-			} else if ($this->getChecksum() !== null && $this->getChecksum() !== '') {
-				$this->fileView->putFileInfo($this->path, ['checksum' => '']);
-				$this->refreshInfo();
-			}
-
-		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("Failed to check file size: " . $e->getMessage(), 0, $e);
-		}
-
-		return '"' . $this->info->getEtag() . '"';
-	}
-
-	private function getPartFileBasePath($path) {
-		$partFileInStorage = \OC::$server->getConfig()->getSystemValue('part_file_in_storage', true);
-		if ($partFileInStorage) {
-			return $path;
-		} else {
-			return md5($path); // will place it in the root of the view with a unique name
-		}
-	}
-
-	/**
-	 * @param string $path
-	 */
-	private function emitPreHooks($exists, $path = null) {
-		if (is_null($path)) {
-			$path = $this->path;
-		}
-		$hookPath = Filesystem::getView()->getRelativePath($this->fileView->getAbsolutePath($path));
-		$run = true;
-
-		if (!$exists) {
-			\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_create, [
-				\OC\Files\Filesystem::signal_param_path => $hookPath,
-				\OC\Files\Filesystem::signal_param_run => &$run,
-			]);
-		} else {
-			\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_update, [
-				\OC\Files\Filesystem::signal_param_path => $hookPath,
-				\OC\Files\Filesystem::signal_param_run => &$run,
-			]);
-		}
-		\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_write, [
-			\OC\Files\Filesystem::signal_param_path => $hookPath,
-			\OC\Files\Filesystem::signal_param_run => &$run,
-		]);
-		return $run;
-	}
-
-	/**
-	 * @param string $path
-	 */
-	private function emitPostHooks($exists, $path = null) {
-		if (is_null($path)) {
-			$path = $this->path;
-		}
-		$hookPath = Filesystem::getView()->getRelativePath($this->fileView->getAbsolutePath($path));
-		if (!$exists) {
-			\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_create, [
-				\OC\Files\Filesystem::signal_param_path => $hookPath
-			]);
-		} else {
-			\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_update, [
-				\OC\Files\Filesystem::signal_param_path => $hookPath
-			]);
-		}
-		\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_write, [
-			\OC\Files\Filesystem::signal_param_path => $hookPath
-		]);
-	}
-
-	/**
-	 * Returns the data
-	 *
-	 * @return resource
-	 * @throws Forbidden
-	 * @throws ServiceUnavailable
-	 */
-	public function get() {
-		//throw exception if encryption is disabled but files are still encrypted
-		try {
-			if (!$this->info->isReadable()) {
-				// do a if the file did not exist
-				throw new NotFound();
-			}
-			try {
-				$res = $this->fileView->fopen(ltrim($this->path, '/'), 'rb');
-			} catch (\Exception $e) {
-				$this->convertToSabreException($e);
-			}
-			if ($res === false) {
-				throw new ServiceUnavailable("Could not open file");
-			}
-			return $res;
-		} catch (GenericEncryptionException $e) {
-			// returning 503 will allow retry of the operation at a later point in time
-			throw new ServiceUnavailable("Encryption not ready: " . $e->getMessage());
-		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("Failed to open file: " . $e->getMessage());
-		} catch (ForbiddenException $ex) {
-			throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
-		} catch (LockedException $e) {
-			throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	/**
-	 * Delete the current file
-	 *
-	 * @throws Forbidden
-	 * @throws ServiceUnavailable
-	 */
-	public function delete() {
-		if (!$this->info->isDeletable()) {
-			throw new Forbidden();
-		}
-
-		try {
-			if (!$this->fileView->unlink($this->path)) {
-				// assume it wasn't possible to delete due to permissions
-				throw new Forbidden();
-			}
-		} catch (StorageNotAvailableException $e) {
-			throw new ServiceUnavailable("Failed to unlink: " . $e->getMessage());
-		} catch (ForbiddenException $ex) {
-			throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
-		} catch (LockedException $e) {
-			throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	/**
-	 * Returns the mime-type for a file
-	 *
-	 * If null is returned, we'll assume application/octet-stream
-	 *
-	 * @return string
-	 */
-	public function getContentType() {
-		$mimeType = $this->info->getMimetype();
-
-		// PROPFIND needs to return the correct mime type, for consistency with the web UI
-		if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PROPFIND') {
-			return $mimeType;
-		}
-		return \OC::$server->getMimeTypeDetector()->getSecureMimeType($mimeType);
-	}
-
-	/**
-	 * @return array|false
-	 */
-	public function getDirectDownload() {
-		if (\OCP\App::isEnabled('encryption')) {
-			return [];
-		}
-		/** @var \OCP\Files\Storage $storage */
-		list($storage, $internalPath) = $this->fileView->resolvePath($this->path);
-		if (is_null($storage)) {
-			return [];
-		}
-
-		return $storage->getDirectDownload($internalPath);
-	}
-
-	/**
-	 * @param resource $data
-	 * @return null|string
-	 * @throws Exception
-	 * @throws BadRequest
-	 * @throws NotImplemented
-	 * @throws ServiceUnavailable
-	 */
-	private function createFileChunked($data) {
-		list($path, $name) = \Sabre\Uri\split($this->path);
-
-		$info = \OC_FileChunking::decodeName($name);
-		if (empty($info)) {
-			throw new NotImplemented('Invalid chunk name');
-		}
-
-		$chunk_handler = new \OC_FileChunking($info);
-		$bytesWritten = $chunk_handler->store($info['index'], $data);
-
-		//detect aborted upload
-		if (isset ($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PUT') {
-			if (isset($_SERVER['CONTENT_LENGTH'])) {
-				$expected = (int)$_SERVER['CONTENT_LENGTH'];
-				if ($bytesWritten !== $expected) {
-					$chunk_handler->remove($info['index']);
-					throw new BadRequest('Expected filesize of ' . $expected . ' bytes but read (from Nextcloud client) and wrote (to Nextcloud storage) ' . $bytesWritten . ' bytes. Could either be a network problem on the sending side or a problem writing to the storage on the server side.');
-				}
-			}
-		}
-
-		if ($chunk_handler->isComplete()) {
-			/** @var Storage $storage */
-			list($storage,) = $this->fileView->resolvePath($path);
-			$needsPartFile = $storage->needsPartFile();
-			$partFile = null;
-
-			$targetPath = $path . '/' . $info['name'];
-			/** @var \OC\Files\Storage\Storage $targetStorage */
-			list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath);
-
-			$exists = $this->fileView->file_exists($targetPath);
-
-			try {
-				$this->fileView->lockFile($targetPath, ILockingProvider::LOCK_SHARED);
-
-				$this->emitPreHooks($exists, $targetPath);
-				$this->fileView->changeLock($targetPath, ILockingProvider::LOCK_EXCLUSIVE);
-				/** @var \OC\Files\Storage\Storage $targetStorage */
-				list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath);
-
-				if ($needsPartFile) {
-					// we first assembly the target file as a part file
-					$partFile = $this->getPartFileBasePath($path . '/' . $info['name']) . '.ocTransferId' . $info['transferid'] . '.part';
-					/** @var \OC\Files\Storage\Storage $targetStorage */
-					list($partStorage, $partInternalPath) = $this->fileView->resolvePath($partFile);
-
-
-					$chunk_handler->file_assemble($partStorage, $partInternalPath);
-
-					// here is the final atomic rename
-					$renameOkay = $targetStorage->moveFromStorage($partStorage, $partInternalPath, $targetInternalPath);
-					$fileExists = $targetStorage->file_exists($targetInternalPath);
-					if ($renameOkay === false || $fileExists === false) {
-						\OC::$server->getLogger()->error('\OC\Files\Filesystem::rename() failed', ['app' => 'webdav']);
-						// only delete if an error occurred and the target file was already created
-						if ($fileExists) {
-							// set to null to avoid double-deletion when handling exception
-							// stray part file
-							$partFile = null;
-							$targetStorage->unlink($targetInternalPath);
-						}
-						$this->fileView->changeLock($targetPath, ILockingProvider::LOCK_SHARED);
-						throw new Exception('Could not rename part file assembled from chunks');
-					}
-				} else {
-					// assemble directly into the final file
-					$chunk_handler->file_assemble($targetStorage, $targetInternalPath);
-				}
-
-				// allow sync clients to send the mtime along in a header
-				if (isset($this->request->server['HTTP_X_OC_MTIME'])) {
-					$mtime = $this->sanitizeMtime($this->request->server['HTTP_X_OC_MTIME']);
-					if ($targetStorage->touch($targetInternalPath, $mtime)) {
-						$this->header('X-OC-MTime: accepted');
-					}
-				}
-
-				// since we skipped the view we need to scan and emit the hooks ourselves
-				$targetStorage->getUpdater()->update($targetInternalPath);
-
-				$this->fileView->changeLock($targetPath, ILockingProvider::LOCK_SHARED);
-
-				$this->emitPostHooks($exists, $targetPath);
-
-				// FIXME: should call refreshInfo but can't because $this->path is not the of the final file
-				$info = $this->fileView->getFileInfo($targetPath);
-
-				if (isset($this->request->server['HTTP_OC_CHECKSUM'])) {
-					$checksum = trim($this->request->server['HTTP_OC_CHECKSUM']);
-					$this->fileView->putFileInfo($targetPath, ['checksum' => $checksum]);
-				} else if ($info->getChecksum() !== null && $info->getChecksum() !== '') {
-					$this->fileView->putFileInfo($this->path, ['checksum' => '']);
-				}
-
-				$this->fileView->unlockFile($targetPath, ILockingProvider::LOCK_SHARED);
-
-				return $info->getEtag();
-			} catch (\Exception $e) {
-				if ($partFile !== null) {
-					$targetStorage->unlink($targetInternalPath);
-				}
-				$this->convertToSabreException($e);
-			}
-		}
-
-		return null;
-	}
-
-	/**
-	 * Convert the given exception to a SabreException instance
-	 *
-	 * @param \Exception $e
-	 *
-	 * @throws \Sabre\DAV\Exception
-	 */
-	private function convertToSabreException(\Exception $e) {
-		if ($e instanceof \Sabre\DAV\Exception) {
-			throw $e;
-		}
-		if ($e instanceof NotPermittedException) {
-			// a more general case - due to whatever reason the content could not be written
-			throw new Forbidden($e->getMessage(), 0, $e);
-		}
-		if ($e instanceof ForbiddenException) {
-			// the path for the file was forbidden
-			throw new DAVForbiddenException($e->getMessage(), $e->getRetry(), $e);
-		}
-		if ($e instanceof EntityTooLargeException) {
-			// the file is too big to be stored
-			throw new EntityTooLarge($e->getMessage(), 0, $e);
-		}
-		if ($e instanceof InvalidContentException) {
-			// the file content is not permitted
-			throw new UnsupportedMediaType($e->getMessage(), 0, $e);
-		}
-		if ($e instanceof InvalidPathException) {
-			// the path for the file was not valid
-			// TODO: find proper http status code for this case
-			throw new Forbidden($e->getMessage(), 0, $e);
-		}
-		if ($e instanceof LockedException || $e instanceof LockNotAcquiredException) {
-			// the file is currently being written to by another process
-			throw new FileLocked($e->getMessage(), $e->getCode(), $e);
-		}
-		if ($e instanceof GenericEncryptionException) {
-			// returning 503 will allow retry of the operation at a later point in time
-			throw new ServiceUnavailable('Encryption not ready: ' . $e->getMessage(), 0, $e);
-		}
-		if ($e instanceof StorageNotAvailableException) {
-			throw new ServiceUnavailable('Failed to write file contents: ' . $e->getMessage(), 0, $e);
-		}
-		if ($e instanceof NotFoundException) {
-			throw new NotFound('File not found: ' . $e->getMessage(), 0, $e);
-		}
-
-		throw new \Sabre\DAV\Exception($e->getMessage(), 0, $e);
-	}
-
-	/**
-	 * Get the checksum for this file
-	 *
-	 * @return string
-	 */
-	public function getChecksum() {
-		return $this->info->getChecksum();
-	}
-
-	protected function header($string) {
-		\header($string);
-	}
+    protected $request;
+
+    /**
+     * Sets up the node, expects a full path name
+     *
+     * @param \OC\Files\View $view
+     * @param \OCP\Files\FileInfo $info
+     * @param \OCP\Share\IManager $shareManager
+     * @param \OC\AppFramework\Http\Request $request
+     */
+    public function __construct(View $view, FileInfo $info, IManager $shareManager = null, Request $request = null) {
+        parent::__construct($view, $info, $shareManager);
+
+        if (isset($request)) {
+            $this->request = $request;
+        } else {
+            $this->request = \OC::$server->getRequest();
+        }
+    }
+
+    /**
+     * Updates the data
+     *
+     * The data argument is a readable stream resource.
+     *
+     * After a successful put operation, you may choose to return an ETag. The
+     * etag must always be surrounded by double-quotes. These quotes must
+     * appear in the actual string you're returning.
+     *
+     * Clients may use the ETag from a PUT request to later on make sure that
+     * when they update the file, the contents haven't changed in the mean
+     * time.
+     *
+     * If you don't plan to store the file byte-by-byte, and you return a
+     * different object on a subsequent GET you are strongly recommended to not
+     * return an ETag, and just return null.
+     *
+     * @param resource $data
+     *
+     * @throws Forbidden
+     * @throws UnsupportedMediaType
+     * @throws BadRequest
+     * @throws Exception
+     * @throws EntityTooLarge
+     * @throws ServiceUnavailable
+     * @throws FileLocked
+     * @return string|null
+     */
+    public function put($data) {
+        try {
+            $exists = $this->fileView->file_exists($this->path);
+            if ($this->info && $exists && !$this->info->isUpdateable()) {
+                throw new Forbidden();
+            }
+        } catch (StorageNotAvailableException $e) {
+            throw new ServiceUnavailable("File is not updatable: " . $e->getMessage());
+        }
+
+        // verify path of the target
+        $this->verifyPath();
+
+        // chunked handling
+        if (isset($_SERVER['HTTP_OC_CHUNKED'])) {
+            try {
+                return $this->createFileChunked($data);
+            } catch (\Exception $e) {
+                $this->convertToSabreException($e);
+            }
+        }
+
+        /** @var Storage $partStorage */
+        list($partStorage) = $this->fileView->resolvePath($this->path);
+        $needsPartFile = $partStorage->needsPartFile() && (strlen($this->path) > 1);
+
+        $view = \OC\Files\Filesystem::getView();
+
+        if ($needsPartFile) {
+            // mark file as partial while uploading (ignored by the scanner)
+            $partFilePath = $this->getPartFileBasePath($this->path) . '.ocTransferId' . rand() . '.part';
+
+            if (!$view->isCreatable($partFilePath) && $view->isUpdatable($this->path)) {
+                $needsPartFile = false;
+            }
+        }
+        if (!$needsPartFile) {
+            // upload file directly as the final path
+            $partFilePath = $this->path;
+
+            if ($view && !$this->emitPreHooks($exists)) {
+                throw new Exception('Could not write to final file, canceled by hook');
+            }
+        }
+
+        // the part file and target file might be on a different storage in case of a single file storage (e.g. single file share)
+        /** @var \OC\Files\Storage\Storage $partStorage */
+        list($partStorage, $internalPartPath) = $this->fileView->resolvePath($partFilePath);
+        /** @var \OC\Files\Storage\Storage $storage */
+        list($storage, $internalPath) = $this->fileView->resolvePath($this->path);
+        try {
+            if (!$needsPartFile) {
+                $this->changeLock(ILockingProvider::LOCK_EXCLUSIVE);
+            }
+
+            if ($partStorage->instanceOfStorage(Storage\IWriteStreamStorage::class)) {
+
+                if (!is_resource($data)) {
+                    $tmpData = fopen('php://temp', 'r+');
+                    if ($data !== null) {
+                        fwrite($tmpData, $data);
+                        rewind($tmpData);
+                    }
+                    $data = $tmpData;
+                }
+
+                $isEOF = false;
+                $wrappedData = CallbackWrapper::wrap($data, null, null, null, null, function ($stream) use (&$isEOF) {
+                    $isEOF = feof($stream);
+                });
+
+                $count = $partStorage->writeStream($internalPartPath, $wrappedData);
+                $result = $count > 0;
+
+                if ($result === false) {
+                    $result = $isEOF;
+                    if (is_resource($wrappedData)) {
+                        $result = feof($wrappedData);
+                    }
+                }
+
+            } else {
+                $target = $partStorage->fopen($internalPartPath, 'wb');
+                if ($target === false) {
+                    \OC::$server->getLogger()->error('\OC\Files\Filesystem::fopen() failed', ['app' => 'webdav']);
+                    // because we have no clue about the cause we can only throw back a 500/Internal Server Error
+                    throw new Exception('Could not write file contents');
+                }
+                list($count, $result) = \OC_Helper::streamCopy($data, $target);
+                fclose($target);
+            }
+
+            if ($result === false) {
+                $expected = -1;
+                if (isset($_SERVER['CONTENT_LENGTH'])) {
+                    $expected = $_SERVER['CONTENT_LENGTH'];
+                }
+                if ($expected !== "0") {
+                    throw new Exception('Error while copying file to target location (copied bytes: ' . $count . ', expected filesize: ' . $expected . ' )');
+                }
+            }
+
+            // if content length is sent by client:
+            // double check if the file was fully received
+            // compare expected and actual size
+            if (isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['REQUEST_METHOD'] === 'PUT') {
+                $expected = (int)$_SERVER['CONTENT_LENGTH'];
+                if ($count !== $expected) {
+                    throw new BadRequest('Expected filesize of ' . $expected . ' bytes but read (from Nextcloud client) and wrote (to Nextcloud storage) ' . $count . ' bytes. Could either be a network problem on the sending side or a problem writing to the storage on the server side.');
+                }
+            }
+
+        } catch (\Exception $e) {
+            $context = [];
+
+            if ($e instanceof LockedException) {
+                $context['level'] = ILogger::DEBUG;
+            }
+
+            \OC::$server->getLogger()->logException($e, $context);
+            if ($needsPartFile) {
+                $partStorage->unlink($internalPartPath);
+            }
+            $this->convertToSabreException($e);
+        }
+
+        try {
+            if ($needsPartFile) {
+                if ($view && !$this->emitPreHooks($exists)) {
+                    $partStorage->unlink($internalPartPath);
+                    throw new Exception('Could not rename part file to final file, canceled by hook');
+                }
+                try {
+                    $this->changeLock(ILockingProvider::LOCK_EXCLUSIVE);
+                } catch (LockedException $e) {
+                    // during very large uploads, the shared lock we got at the start might have been expired
+                    // meaning that the above lock can fail not just only because somebody else got a shared lock
+                    // or because there is no existing shared lock to make exclusive
+                    //
+                    // Thus we try to get a new exclusive lock, if the original lock failed because of a different shared
+                    // lock this will still fail, if our original shared lock expired the new lock will be successful and
+                    // the entire operation will be safe
+
+                    try {
+                        $this->acquireLock(ILockingProvider::LOCK_EXCLUSIVE);
+                    } catch (LockedException $ex) {
+                        if ($needsPartFile) {
+                            $partStorage->unlink($internalPartPath);
+                        }
+                        throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+                    }
+                }
+
+                // rename to correct path
+                try {
+                    $renameOkay = $storage->moveFromStorage($partStorage, $internalPartPath, $internalPath);
+                    $fileExists = $storage->file_exists($internalPath);
+                    if ($renameOkay === false || $fileExists === false) {
+                        \OC::$server->getLogger()->error('renaming part file to final file failed $renameOkay: ' . ($renameOkay ? 'true' : 'false') . ', $fileExists: ' . ($fileExists ? 'true' : 'false') . ')', ['app' => 'webdav']);
+                        throw new Exception('Could not rename part file to final file');
+                    }
+                } catch (ForbiddenException $ex) {
+                    throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
+                } catch (\Exception $e) {
+                    $partStorage->unlink($internalPartPath);
+                    $this->convertToSabreException($e);
+                }
+            }
+
+            // since we skipped the view we need to scan and emit the hooks ourselves
+            $storage->getUpdater()->update($internalPath);
+
+            try {
+                $this->changeLock(ILockingProvider::LOCK_SHARED);
+            } catch (LockedException $e) {
+                throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+            }
+
+            // allow sync clients to send the mtime along in a header
+            if (isset($this->request->server['HTTP_X_OC_MTIME'])) {
+                $mtime = $this->sanitizeMtime($this->request->server['HTTP_X_OC_MTIME']);
+                if ($this->fileView->touch($this->path, $mtime)) {
+                    $this->header('X-OC-MTime: accepted');
+                }
+            }
+
+            $fileInfoUpdate = [
+                'upload_time' => time()
+            ];
+
+            // allow sync clients to send the creation time along in a header
+            if (isset($this->request->server['HTTP_X_OC_CTIME'])) {
+                $ctime = $this->sanitizeMtime($this->request->server['HTTP_X_OC_CTIME']);
+                $fileInfoUpdate['creation_time'] = $ctime;
+                $this->header('X-OC-CTime: accepted');
+            }
+
+            $this->fileView->putFileInfo($this->path, $fileInfoUpdate);
+
+            if ($view) {
+                $this->emitPostHooks($exists);
+            }
+
+            $this->refreshInfo();
+
+            if (isset($this->request->server['HTTP_OC_CHECKSUM'])) {
+                $checksum = trim($this->request->server['HTTP_OC_CHECKSUM']);
+                $this->fileView->putFileInfo($this->path, ['checksum' => $checksum]);
+                $this->refreshInfo();
+            } else if ($this->getChecksum() !== null && $this->getChecksum() !== '') {
+                $this->fileView->putFileInfo($this->path, ['checksum' => '']);
+                $this->refreshInfo();
+            }
+
+        } catch (StorageNotAvailableException $e) {
+            throw new ServiceUnavailable("Failed to check file size: " . $e->getMessage(), 0, $e);
+        }
+
+        return '"' . $this->info->getEtag() . '"';
+    }
+
+    private function getPartFileBasePath($path) {
+        $partFileInStorage = \OC::$server->getConfig()->getSystemValue('part_file_in_storage', true);
+        if ($partFileInStorage) {
+            return $path;
+        } else {
+            return md5($path); // will place it in the root of the view with a unique name
+        }
+    }
+
+    /**
+     * @param string $path
+     */
+    private function emitPreHooks($exists, $path = null) {
+        if (is_null($path)) {
+            $path = $this->path;
+        }
+        $hookPath = Filesystem::getView()->getRelativePath($this->fileView->getAbsolutePath($path));
+        $run = true;
+
+        if (!$exists) {
+            \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_create, [
+                \OC\Files\Filesystem::signal_param_path => $hookPath,
+                \OC\Files\Filesystem::signal_param_run => &$run,
+            ]);
+        } else {
+            \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_update, [
+                \OC\Files\Filesystem::signal_param_path => $hookPath,
+                \OC\Files\Filesystem::signal_param_run => &$run,
+            ]);
+        }
+        \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_write, [
+            \OC\Files\Filesystem::signal_param_path => $hookPath,
+            \OC\Files\Filesystem::signal_param_run => &$run,
+        ]);
+        return $run;
+    }
+
+    /**
+     * @param string $path
+     */
+    private function emitPostHooks($exists, $path = null) {
+        if (is_null($path)) {
+            $path = $this->path;
+        }
+        $hookPath = Filesystem::getView()->getRelativePath($this->fileView->getAbsolutePath($path));
+        if (!$exists) {
+            \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_create, [
+                \OC\Files\Filesystem::signal_param_path => $hookPath
+            ]);
+        } else {
+            \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_update, [
+                \OC\Files\Filesystem::signal_param_path => $hookPath
+            ]);
+        }
+        \OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_write, [
+            \OC\Files\Filesystem::signal_param_path => $hookPath
+        ]);
+    }
+
+    /**
+     * Returns the data
+     *
+     * @return resource
+     * @throws Forbidden
+     * @throws ServiceUnavailable
+     */
+    public function get() {
+        //throw exception if encryption is disabled but files are still encrypted
+        try {
+            if (!$this->info->isReadable()) {
+                // do a if the file did not exist
+                throw new NotFound();
+            }
+            try {
+                $res = $this->fileView->fopen(ltrim($this->path, '/'), 'rb');
+            } catch (\Exception $e) {
+                $this->convertToSabreException($e);
+            }
+            if ($res === false) {
+                throw new ServiceUnavailable("Could not open file");
+            }
+            return $res;
+        } catch (GenericEncryptionException $e) {
+            // returning 503 will allow retry of the operation at a later point in time
+            throw new ServiceUnavailable("Encryption not ready: " . $e->getMessage());
+        } catch (StorageNotAvailableException $e) {
+            throw new ServiceUnavailable("Failed to open file: " . $e->getMessage());
+        } catch (ForbiddenException $ex) {
+            throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
+        } catch (LockedException $e) {
+            throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    /**
+     * Delete the current file
+     *
+     * @throws Forbidden
+     * @throws ServiceUnavailable
+     */
+    public function delete() {
+        if (!$this->info->isDeletable()) {
+            throw new Forbidden();
+        }
+
+        try {
+            if (!$this->fileView->unlink($this->path)) {
+                // assume it wasn't possible to delete due to permissions
+                throw new Forbidden();
+            }
+        } catch (StorageNotAvailableException $e) {
+            throw new ServiceUnavailable("Failed to unlink: " . $e->getMessage());
+        } catch (ForbiddenException $ex) {
+            throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
+        } catch (LockedException $e) {
+            throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    /**
+     * Returns the mime-type for a file
+     *
+     * If null is returned, we'll assume application/octet-stream
+     *
+     * @return string
+     */
+    public function getContentType() {
+        $mimeType = $this->info->getMimetype();
+
+        // PROPFIND needs to return the correct mime type, for consistency with the web UI
+        if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PROPFIND') {
+            return $mimeType;
+        }
+        return \OC::$server->getMimeTypeDetector()->getSecureMimeType($mimeType);
+    }
+
+    /**
+     * @return array|false
+     */
+    public function getDirectDownload() {
+        if (\OCP\App::isEnabled('encryption')) {
+            return [];
+        }
+        /** @var \OCP\Files\Storage $storage */
+        list($storage, $internalPath) = $this->fileView->resolvePath($this->path);
+        if (is_null($storage)) {
+            return [];
+        }
+
+        return $storage->getDirectDownload($internalPath);
+    }
+
+    /**
+     * @param resource $data
+     * @return null|string
+     * @throws Exception
+     * @throws BadRequest
+     * @throws NotImplemented
+     * @throws ServiceUnavailable
+     */
+    private function createFileChunked($data) {
+        list($path, $name) = \Sabre\Uri\split($this->path);
+
+        $info = \OC_FileChunking::decodeName($name);
+        if (empty($info)) {
+            throw new NotImplemented('Invalid chunk name');
+        }
+
+        $chunk_handler = new \OC_FileChunking($info);
+        $bytesWritten = $chunk_handler->store($info['index'], $data);
+
+        //detect aborted upload
+        if (isset ($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PUT') {
+            if (isset($_SERVER['CONTENT_LENGTH'])) {
+                $expected = (int)$_SERVER['CONTENT_LENGTH'];
+                if ($bytesWritten !== $expected) {
+                    $chunk_handler->remove($info['index']);
+                    throw new BadRequest('Expected filesize of ' . $expected . ' bytes but read (from Nextcloud client) and wrote (to Nextcloud storage) ' . $bytesWritten . ' bytes. Could either be a network problem on the sending side or a problem writing to the storage on the server side.');
+                }
+            }
+        }
+
+        if ($chunk_handler->isComplete()) {
+            /** @var Storage $storage */
+            list($storage,) = $this->fileView->resolvePath($path);
+            $needsPartFile = $storage->needsPartFile();
+            $partFile = null;
+
+            $targetPath = $path . '/' . $info['name'];
+            /** @var \OC\Files\Storage\Storage $targetStorage */
+            list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath);
+
+            $exists = $this->fileView->file_exists($targetPath);
+
+            try {
+                $this->fileView->lockFile($targetPath, ILockingProvider::LOCK_SHARED);
+
+                $this->emitPreHooks($exists, $targetPath);
+                $this->fileView->changeLock($targetPath, ILockingProvider::LOCK_EXCLUSIVE);
+                /** @var \OC\Files\Storage\Storage $targetStorage */
+                list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath);
+
+                if ($needsPartFile) {
+                    // we first assembly the target file as a part file
+                    $partFile = $this->getPartFileBasePath($path . '/' . $info['name']) . '.ocTransferId' . $info['transferid'] . '.part';
+                    /** @var \OC\Files\Storage\Storage $targetStorage */
+                    list($partStorage, $partInternalPath) = $this->fileView->resolvePath($partFile);
+
+
+                    $chunk_handler->file_assemble($partStorage, $partInternalPath);
+
+                    // here is the final atomic rename
+                    $renameOkay = $targetStorage->moveFromStorage($partStorage, $partInternalPath, $targetInternalPath);
+                    $fileExists = $targetStorage->file_exists($targetInternalPath);
+                    if ($renameOkay === false || $fileExists === false) {
+                        \OC::$server->getLogger()->error('\OC\Files\Filesystem::rename() failed', ['app' => 'webdav']);
+                        // only delete if an error occurred and the target file was already created
+                        if ($fileExists) {
+                            // set to null to avoid double-deletion when handling exception
+                            // stray part file
+                            $partFile = null;
+                            $targetStorage->unlink($targetInternalPath);
+                        }
+                        $this->fileView->changeLock($targetPath, ILockingProvider::LOCK_SHARED);
+                        throw new Exception('Could not rename part file assembled from chunks');
+                    }
+                } else {
+                    // assemble directly into the final file
+                    $chunk_handler->file_assemble($targetStorage, $targetInternalPath);
+                }
+
+                // allow sync clients to send the mtime along in a header
+                if (isset($this->request->server['HTTP_X_OC_MTIME'])) {
+                    $mtime = $this->sanitizeMtime($this->request->server['HTTP_X_OC_MTIME']);
+                    if ($targetStorage->touch($targetInternalPath, $mtime)) {
+                        $this->header('X-OC-MTime: accepted');
+                    }
+                }
+
+                // since we skipped the view we need to scan and emit the hooks ourselves
+                $targetStorage->getUpdater()->update($targetInternalPath);
+
+                $this->fileView->changeLock($targetPath, ILockingProvider::LOCK_SHARED);
+
+                $this->emitPostHooks($exists, $targetPath);
+
+                // FIXME: should call refreshInfo but can't because $this->path is not the of the final file
+                $info = $this->fileView->getFileInfo($targetPath);
+
+                if (isset($this->request->server['HTTP_OC_CHECKSUM'])) {
+                    $checksum = trim($this->request->server['HTTP_OC_CHECKSUM']);
+                    $this->fileView->putFileInfo($targetPath, ['checksum' => $checksum]);
+                } else if ($info->getChecksum() !== null && $info->getChecksum() !== '') {
+                    $this->fileView->putFileInfo($this->path, ['checksum' => '']);
+                }
+
+                $this->fileView->unlockFile($targetPath, ILockingProvider::LOCK_SHARED);
+
+                return $info->getEtag();
+            } catch (\Exception $e) {
+                if ($partFile !== null) {
+                    $targetStorage->unlink($targetInternalPath);
+                }
+                $this->convertToSabreException($e);
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * Convert the given exception to a SabreException instance
+     *
+     * @param \Exception $e
+     *
+     * @throws \Sabre\DAV\Exception
+     */
+    private function convertToSabreException(\Exception $e) {
+        if ($e instanceof \Sabre\DAV\Exception) {
+            throw $e;
+        }
+        if ($e instanceof NotPermittedException) {
+            // a more general case - due to whatever reason the content could not be written
+            throw new Forbidden($e->getMessage(), 0, $e);
+        }
+        if ($e instanceof ForbiddenException) {
+            // the path for the file was forbidden
+            throw new DAVForbiddenException($e->getMessage(), $e->getRetry(), $e);
+        }
+        if ($e instanceof EntityTooLargeException) {
+            // the file is too big to be stored
+            throw new EntityTooLarge($e->getMessage(), 0, $e);
+        }
+        if ($e instanceof InvalidContentException) {
+            // the file content is not permitted
+            throw new UnsupportedMediaType($e->getMessage(), 0, $e);
+        }
+        if ($e instanceof InvalidPathException) {
+            // the path for the file was not valid
+            // TODO: find proper http status code for this case
+            throw new Forbidden($e->getMessage(), 0, $e);
+        }
+        if ($e instanceof LockedException || $e instanceof LockNotAcquiredException) {
+            // the file is currently being written to by another process
+            throw new FileLocked($e->getMessage(), $e->getCode(), $e);
+        }
+        if ($e instanceof GenericEncryptionException) {
+            // returning 503 will allow retry of the operation at a later point in time
+            throw new ServiceUnavailable('Encryption not ready: ' . $e->getMessage(), 0, $e);
+        }
+        if ($e instanceof StorageNotAvailableException) {
+            throw new ServiceUnavailable('Failed to write file contents: ' . $e->getMessage(), 0, $e);
+        }
+        if ($e instanceof NotFoundException) {
+            throw new NotFound('File not found: ' . $e->getMessage(), 0, $e);
+        }
+
+        throw new \Sabre\DAV\Exception($e->getMessage(), 0, $e);
+    }
+
+    /**
+     * Get the checksum for this file
+     *
+     * @return string
+     */
+    public function getChecksum() {
+        return $this->info->getChecksum();
+    }
+
+    protected function header($string) {
+        \header($string);
+    }
 }

apps/dav/lib/Connector/Sabre/CommentPropertiesPlugin.php

Indentation +127 added lines, -127 removed lines

@@ -32,132 +32,132 @@
 
 class CommentPropertiesPlugin extends ServerPlugin {
 
-	const PROPERTY_NAME_HREF   = '{http://owncloud.org/ns}comments-href';
-	const PROPERTY_NAME_COUNT  = '{http://owncloud.org/ns}comments-count';
-	const PROPERTY_NAME_UNREAD = '{http://owncloud.org/ns}comments-unread';
-
-	/** @var  \Sabre\DAV\Server */
-	protected $server;
-
-	/** @var ICommentsManager */
-	private $commentsManager;
-
-	/** @var IUserSession */
-	private $userSession;
-
-	private $cachedUnreadCount = [];
-
-	private $cachedFolders = [];
-
-	public function __construct(ICommentsManager $commentsManager, IUserSession $userSession) {
-		$this->commentsManager = $commentsManager;
-		$this->userSession = $userSession;
-	}
-
-	/**
-	 * This initializes the plugin.
-	 *
-	 * This function is called by Sabre\DAV\Server, after
-	 * addPlugin is called.
-	 *
-	 * This method should set up the required event subscriptions.
-	 *
-	 * @param \Sabre\DAV\Server $server
-	 * @return void
-	 */
-	function initialize(\Sabre\DAV\Server $server) {
-		$this->server = $server;
-		$this->server->on('propFind', [$this, 'handleGetProperties']);
-	}
-
-	/**
-	 * Adds tags and favorites properties to the response,
-	 * if requested.
-	 *
-	 * @param PropFind $propFind
-	 * @param \Sabre\DAV\INode $node
-	 * @return void
-	 */
-	public function handleGetProperties(
-		PropFind $propFind,
-		\Sabre\DAV\INode $node
-	) {
-		if (!($node instanceof File) && !($node instanceof Directory)) {
-			return;
-		}
-
-		// need prefetch ?
-		if ($node instanceof \OCA\DAV\Connector\Sabre\Directory
-			&& $propFind->getDepth() !== 0
-			&& !is_null($propFind->getStatus(self::PROPERTY_NAME_UNREAD))
-		) {
-			$unreadCounts = $this->commentsManager->getNumberOfUnreadCommentsForFolder($node->getId(), $this->userSession->getUser());
-			$this->cachedFolders[] = $node->getPath();
-			foreach ($unreadCounts as $id => $count) {
-				$this->cachedUnreadCount[$id] = $count;
-			}
-		}
-
-		$propFind->handle(self::PROPERTY_NAME_COUNT, function() use ($node) {
-			return $this->commentsManager->getNumberOfCommentsForObject('files', (string)$node->getId());
-		});
-
-		$propFind->handle(self::PROPERTY_NAME_HREF, function() use ($node) {
-			return $this->getCommentsLink($node);
-		});
-
-		$propFind->handle(self::PROPERTY_NAME_UNREAD, function() use ($node) {
-			if (isset($this->cachedUnreadCount[$node->getId()])) {
-				return $this->cachedUnreadCount[$node->getId()];
-			} else {
-				list($parentPath,) = \Sabre\Uri\split($node->getPath());
-				if ($parentPath === '') {
-					$parentPath = '/';
-				}
-				// if we already cached the folder this file is in we know there are no comments for this file
-				if (array_search($parentPath, $this->cachedFolders) === false) {
-					return 0;
-				} else {
-					return $this->getUnreadCount($node);
-				}
-			}
-		});
-	}
-
-	/**
-	 * returns a reference to the comments node
-	 *
-	 * @param Node $node
-	 * @return mixed|string
-	 */
-	public function getCommentsLink(Node $node) {
-		$href =  $this->server->getBaseUri();
-		$entryPoint = strpos($href, '/remote.php/');
-		if($entryPoint === false) {
-			// in case we end up somewhere else, unexpectedly.
-			return null;
-		}
-		$commentsPart = 'dav/comments/files/' . rawurldecode($node->getId());
-		$href = substr_replace($href, $commentsPart, $entryPoint + strlen('/remote.php/'));
-		return $href;
-	}
-
-	/**
-	 * returns the number of unread comments for the currently logged in user
-	 * on the given file or directory node
-	 *
-	 * @param Node $node
-	 * @return Int|null
-	 */
-	public function getUnreadCount(Node $node) {
-		$user = $this->userSession->getUser();
-		if(is_null($user)) {
-			return null;
-		}
-
-		$lastRead = $this->commentsManager->getReadMark('files', (string)$node->getId(), $user);
-
-		return $this->commentsManager->getNumberOfCommentsForObject('files', (string)$node->getId(), $lastRead);
-	}
+    const PROPERTY_NAME_HREF   = '{http://owncloud.org/ns}comments-href';
+    const PROPERTY_NAME_COUNT  = '{http://owncloud.org/ns}comments-count';
+    const PROPERTY_NAME_UNREAD = '{http://owncloud.org/ns}comments-unread';
+
+    /** @var  \Sabre\DAV\Server */
+    protected $server;
+
+    /** @var ICommentsManager */
+    private $commentsManager;
+
+    /** @var IUserSession */
+    private $userSession;
+
+    private $cachedUnreadCount = [];
+
+    private $cachedFolders = [];
+
+    public function __construct(ICommentsManager $commentsManager, IUserSession $userSession) {
+        $this->commentsManager = $commentsManager;
+        $this->userSession = $userSession;
+    }
+
+    /**
+     * This initializes the plugin.
+     *
+     * This function is called by Sabre\DAV\Server, after
+     * addPlugin is called.
+     *
+     * This method should set up the required event subscriptions.
+     *
+     * @param \Sabre\DAV\Server $server
+     * @return void
+     */
+    function initialize(\Sabre\DAV\Server $server) {
+        $this->server = $server;
+        $this->server->on('propFind', [$this, 'handleGetProperties']);
+    }
+
+    /**
+     * Adds tags and favorites properties to the response,
+     * if requested.
+     *
+     * @param PropFind $propFind
+     * @param \Sabre\DAV\INode $node
+     * @return void
+     */
+    public function handleGetProperties(
+        PropFind $propFind,
+        \Sabre\DAV\INode $node
+    ) {
+        if (!($node instanceof File) && !($node instanceof Directory)) {
+            return;
+        }
+
+        // need prefetch ?
+        if ($node instanceof \OCA\DAV\Connector\Sabre\Directory
+            && $propFind->getDepth() !== 0
+            && !is_null($propFind->getStatus(self::PROPERTY_NAME_UNREAD))
+        ) {
+            $unreadCounts = $this->commentsManager->getNumberOfUnreadCommentsForFolder($node->getId(), $this->userSession->getUser());
+            $this->cachedFolders[] = $node->getPath();
+            foreach ($unreadCounts as $id => $count) {
+                $this->cachedUnreadCount[$id] = $count;
+            }
+        }
+
+        $propFind->handle(self::PROPERTY_NAME_COUNT, function() use ($node) {
+            return $this->commentsManager->getNumberOfCommentsForObject('files', (string)$node->getId());
+        });
+
+        $propFind->handle(self::PROPERTY_NAME_HREF, function() use ($node) {
+            return $this->getCommentsLink($node);
+        });
+
+        $propFind->handle(self::PROPERTY_NAME_UNREAD, function() use ($node) {
+            if (isset($this->cachedUnreadCount[$node->getId()])) {
+                return $this->cachedUnreadCount[$node->getId()];
+            } else {
+                list($parentPath,) = \Sabre\Uri\split($node->getPath());
+                if ($parentPath === '') {
+                    $parentPath = '/';
+                }
+                // if we already cached the folder this file is in we know there are no comments for this file
+                if (array_search($parentPath, $this->cachedFolders) === false) {
+                    return 0;
+                } else {
+                    return $this->getUnreadCount($node);
+                }
+            }
+        });
+    }
+
+    /**
+     * returns a reference to the comments node
+     *
+     * @param Node $node
+     * @return mixed|string
+     */
+    public function getCommentsLink(Node $node) {
+        $href =  $this->server->getBaseUri();
+        $entryPoint = strpos($href, '/remote.php/');
+        if($entryPoint === false) {
+            // in case we end up somewhere else, unexpectedly.
+            return null;
+        }
+        $commentsPart = 'dav/comments/files/' . rawurldecode($node->getId());
+        $href = substr_replace($href, $commentsPart, $entryPoint + strlen('/remote.php/'));
+        return $href;
+    }
+
+    /**
+     * returns the number of unread comments for the currently logged in user
+     * on the given file or directory node
+     *
+     * @param Node $node
+     * @return Int|null
+     */
+    public function getUnreadCount(Node $node) {
+        $user = $this->userSession->getUser();
+        if(is_null($user)) {
+            return null;
+        }
+
+        $lastRead = $this->commentsManager->getReadMark('files', (string)$node->getId(), $user);
+
+        return $this->commentsManager->getNumberOfCommentsForObject('files', (string)$node->getId(), $lastRead);
+    }
 
 }

apps/dav/lib/Migration/RemoveOrphanEventsAndContacts.php

Indentation +72 added lines, -72 removed lines

@@ -35,76 +35,76 @@
 
 class RemoveOrphanEventsAndContacts implements IRepairStep {
 
-	/** @var IDBConnection */
-	private $connection;
-
-	public function __construct(IDBConnection $connection) {
-		$this->connection = $connection;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getName(): string {
-		return 'Clean up orphan event and contact data';
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function run(IOutput $output) {
-		$orphanItems = $this->removeOrphanChildren('calendarobjects', 'calendars',  'calendarid');
-		$output->info(sprintf('%d events without a calendar have been cleaned up', $orphanItems));
-		$orphanItems = $this->removeOrphanChildren('calendarobjects_props', 'calendarobjects',  'objectid');
-		$output->info(sprintf('%d properties without an events have been cleaned up', $orphanItems));
-		$orphanItems = $this->removeOrphanChildren('calendarchanges', 'calendars',  'calendarid');
-		$output->info(sprintf('%d changes without a calendar have been cleaned up', $orphanItems));
-
-		$orphanItems = $this->removeOrphanChildren('calendarobjects', 'calendarsubscriptions',  'calendarid');
-		$output->info(sprintf('%d cached events without a calendar subscription have been cleaned up', $orphanItems));
-		$orphanItems = $this->removeOrphanChildren('calendarchanges', 'calendarsubscriptions',  'calendarid');
-		$output->info(sprintf('%d changes without a calendar subscription have been cleaned up', $orphanItems));
-
-		$orphanItems = $this->removeOrphanChildren('cards', 'addressbooks',  'addressbookid');
-		$output->info(sprintf('%d contacts without an addressbook have been cleaned up', $orphanItems));
-		$orphanItems = $this->removeOrphanChildren('cards_properties', 'cards',  'cardid');
-		$output->info(sprintf('%d properties without a contact have been cleaned up', $orphanItems));
-		$orphanItems = $this->removeOrphanChildren('addressbookchanges', 'addressbooks',  'addressbookid');
-		$output->info(sprintf('%d changes without an addressbook have been cleaned up', $orphanItems));
-	}
-
-	protected function removeOrphanChildren($childTable, $parentTable, $parentId): int {
-		$qb = $this->connection->getQueryBuilder();
-
-		$qb->select('c.id')
-			->from($childTable, 'c')
-			->leftJoin('c', $parentTable, 'p', $qb->expr()->eq('c.' . $parentId, 'p.id'))
-			->where($qb->expr()->isNull('p.id'));
-
-		if (\in_array($parentTable, ['calendars', 'calendarsubscriptions'], true)) {
-			$calendarType = $parentTable === 'calendarsubscriptions' ? CalDavBackend::CALENDAR_TYPE_SUBSCRIPTION : CalDavBackend::CALENDAR_TYPE_CALENDAR;
-			$qb->andWhere($qb->expr()->eq('c.calendartype', $qb->createNamedParameter($calendarType, IQueryBuilder::PARAM_INT), IQueryBuilder::PARAM_INT));
-		}
-
-		$result = $qb->execute();
-
-		$orphanItems = [];
-		while ($row = $result->fetch()) {
-			$orphanItems[] = (int) $row['id'];
-		}
-		$result->closeCursor();
-
-		if (!empty($orphanItems)) {
-			$qb->delete($childTable)
-				->where($qb->expr()->in('id', $qb->createParameter('ids')));
-
-			$orphanItemsBatch = array_chunk($orphanItems, 200);
-			foreach ($orphanItemsBatch as $items) {
-				$qb->setParameter('ids', $items, IQueryBuilder::PARAM_INT_ARRAY);
-				$qb->execute();
-			}
-		}
-
-		return count($orphanItems);
-	}
+    /** @var IDBConnection */
+    private $connection;
+
+    public function __construct(IDBConnection $connection) {
+        $this->connection = $connection;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getName(): string {
+        return 'Clean up orphan event and contact data';
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function run(IOutput $output) {
+        $orphanItems = $this->removeOrphanChildren('calendarobjects', 'calendars',  'calendarid');
+        $output->info(sprintf('%d events without a calendar have been cleaned up', $orphanItems));
+        $orphanItems = $this->removeOrphanChildren('calendarobjects_props', 'calendarobjects',  'objectid');
+        $output->info(sprintf('%d properties without an events have been cleaned up', $orphanItems));
+        $orphanItems = $this->removeOrphanChildren('calendarchanges', 'calendars',  'calendarid');
+        $output->info(sprintf('%d changes without a calendar have been cleaned up', $orphanItems));
+
+        $orphanItems = $this->removeOrphanChildren('calendarobjects', 'calendarsubscriptions',  'calendarid');
+        $output->info(sprintf('%d cached events without a calendar subscription have been cleaned up', $orphanItems));
+        $orphanItems = $this->removeOrphanChildren('calendarchanges', 'calendarsubscriptions',  'calendarid');
+        $output->info(sprintf('%d changes without a calendar subscription have been cleaned up', $orphanItems));
+
+        $orphanItems = $this->removeOrphanChildren('cards', 'addressbooks',  'addressbookid');
+        $output->info(sprintf('%d contacts without an addressbook have been cleaned up', $orphanItems));
+        $orphanItems = $this->removeOrphanChildren('cards_properties', 'cards',  'cardid');
+        $output->info(sprintf('%d properties without a contact have been cleaned up', $orphanItems));
+        $orphanItems = $this->removeOrphanChildren('addressbookchanges', 'addressbooks',  'addressbookid');
+        $output->info(sprintf('%d changes without an addressbook have been cleaned up', $orphanItems));
+    }
+
+    protected function removeOrphanChildren($childTable, $parentTable, $parentId): int {
+        $qb = $this->connection->getQueryBuilder();
+
+        $qb->select('c.id')
+            ->from($childTable, 'c')
+            ->leftJoin('c', $parentTable, 'p', $qb->expr()->eq('c.' . $parentId, 'p.id'))
+            ->where($qb->expr()->isNull('p.id'));
+
+        if (\in_array($parentTable, ['calendars', 'calendarsubscriptions'], true)) {
+            $calendarType = $parentTable === 'calendarsubscriptions' ? CalDavBackend::CALENDAR_TYPE_SUBSCRIPTION : CalDavBackend::CALENDAR_TYPE_CALENDAR;
+            $qb->andWhere($qb->expr()->eq('c.calendartype', $qb->createNamedParameter($calendarType, IQueryBuilder::PARAM_INT), IQueryBuilder::PARAM_INT));
+        }
+
+        $result = $qb->execute();
+
+        $orphanItems = [];
+        while ($row = $result->fetch()) {
+            $orphanItems[] = (int) $row['id'];
+        }
+        $result->closeCursor();
+
+        if (!empty($orphanItems)) {
+            $qb->delete($childTable)
+                ->where($qb->expr()->in('id', $qb->createParameter('ids')));
+
+            $orphanItemsBatch = array_chunk($orphanItems, 200);
+            foreach ($orphanItemsBatch as $items) {
+                $qb->setParameter('ids', $items, IQueryBuilder::PARAM_INT_ARRAY);
+                $qb->execute();
+            }
+        }
+
+        return count($orphanItems);
+    }
 }

apps/dav/lib/CardDAV/CardDavBackend.php

Indentation +1118 added lines, -1118 removed lines

@@ -55,1122 +55,1122 @@
 
 class CardDavBackend implements BackendInterface, SyncSupport {
 
-	const PERSONAL_ADDRESSBOOK_URI = 'contacts';
-	const PERSONAL_ADDRESSBOOK_NAME = 'Contacts';
-
-	/** @var Principal */
-	private $principalBackend;
-
-	/** @var string */
-	private $dbCardsTable = 'cards';
-
-	/** @var string */
-	private $dbCardsPropertiesTable = 'cards_properties';
-
-	/** @var IDBConnection */
-	private $db;
-
-	/** @var Backend */
-	private $sharingBackend;
-
-	/** @var array properties to index */
-	public static $indexProperties = [
-			'BDAY', 'UID', 'N', 'FN', 'TITLE', 'ROLE', 'NOTE', 'NICKNAME',
-			'ORG', 'CATEGORIES', 'EMAIL', 'TEL', 'IMPP', 'ADR', 'URL', 'GEO', 'CLOUD'];
-
-	/**
-	 * @var string[] Map of uid => display name
-	 */
-	protected $userDisplayNames;
-
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var EventDispatcherInterface */
-	private $dispatcher;
-
-	/**
-	 * CardDavBackend constructor.
-	 *
-	 * @param IDBConnection $db
-	 * @param Principal $principalBackend
-	 * @param IUserManager $userManager
-	 * @param IGroupManager $groupManager
-	 * @param EventDispatcherInterface $dispatcher
-	 */
-	public function __construct(IDBConnection $db,
-								Principal $principalBackend,
-								IUserManager $userManager,
-								IGroupManager $groupManager,
-								EventDispatcherInterface $dispatcher) {
-		$this->db = $db;
-		$this->principalBackend = $principalBackend;
-		$this->userManager = $userManager;
-		$this->dispatcher = $dispatcher;
-		$this->sharingBackend = new Backend($this->db, $this->userManager, $groupManager, $principalBackend, 'addressbook');
-	}
-
-	/**
-	 * Return the number of address books for a principal
-	 *
-	 * @param $principalUri
-	 * @return int
-	 */
-	public function getAddressBooksForUserCount($principalUri) {
-		$principalUri = $this->convertPrincipal($principalUri, true);
-		$query = $this->db->getQueryBuilder();
-		$query->select($query->func()->count('*'))
-			->from('addressbooks')
-			->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
-
-		return (int)$query->execute()->fetchColumn();
-	}
-
-	/**
-	 * Returns the list of address books for a specific user.
-	 *
-	 * Every addressbook should have the following properties:
-	 *   id - an arbitrary unique id
-	 *   uri - the 'basename' part of the url
-	 *   principaluri - Same as the passed parameter
-	 *
-	 * Any additional clark-notation property may be passed besides this. Some
-	 * common ones are :
-	 *   {DAV:}displayname
-	 *   {urn:ietf:params:xml:ns:carddav}addressbook-description
-	 *   {http://calendarserver.org/ns/}getctag
-	 *
-	 * @param string $principalUri
-	 * @return array
-	 */
-	function getAddressBooksForUser($principalUri) {
-		$principalUriOriginal = $principalUri;
-		$principalUri = $this->convertPrincipal($principalUri, true);
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
-			->from('addressbooks')
-			->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
-
-		$addressBooks = [];
-
-		$result = $query->execute();
-		while($row = $result->fetch()) {
-			$addressBooks[$row['id']] = [
-				'id'  => $row['id'],
-				'uri' => $row['uri'],
-				'principaluri' => $this->convertPrincipal($row['principaluri'], false),
-				'{DAV:}displayname' => $row['displayname'],
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-			];
-
-			$this->addOwnerPrincipal($addressBooks[$row['id']]);
-		}
-		$result->closeCursor();
-
-		// query for shared addressbooks
-		$principals = $this->principalBackend->getGroupMembership($principalUriOriginal, true);
-		$principals = array_merge($principals, $this->principalBackend->getCircleMembership($principalUriOriginal));
-
-		$principals = array_map(function($principal) {
-			return urldecode($principal);
-		}, $principals);
-		$principals[]= $principalUri;
-
-		$query = $this->db->getQueryBuilder();
-		$result = $query->select(['a.id', 'a.uri', 'a.displayname', 'a.principaluri', 'a.description', 'a.synctoken', 's.access'])
-			->from('dav_shares', 's')
-			->join('s', 'addressbooks', 'a', $query->expr()->eq('s.resourceid', 'a.id'))
-			->where($query->expr()->in('s.principaluri', $query->createParameter('principaluri')))
-			->andWhere($query->expr()->eq('s.type', $query->createParameter('type')))
-			->setParameter('type', 'addressbook')
-			->setParameter('principaluri', $principals, IQueryBuilder::PARAM_STR_ARRAY)
-			->execute();
-
-		$readOnlyPropertyName = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}read-only';
-		while($row = $result->fetch()) {
-			if ($row['principaluri'] === $principalUri) {
-				continue;
-			}
-
-			$readOnly = (int) $row['access'] === Backend::ACCESS_READ;
-			if (isset($addressBooks[$row['id']])) {
-				if ($readOnly) {
-					// New share can not have more permissions then the old one.
-					continue;
-				}
-				if (isset($addressBooks[$row['id']][$readOnlyPropertyName]) &&
-					$addressBooks[$row['id']][$readOnlyPropertyName] === 0) {
-					// Old share is already read-write, no more permissions can be gained
-					continue;
-				}
-			}
-
-			list(, $name) = \Sabre\Uri\split($row['principaluri']);
-			$uri = $row['uri'] . '_shared_by_' . $name;
-			$displayName = $row['displayname'] . ' (' . $this->getUserDisplayName($name) . ')';
-
-			$addressBooks[$row['id']] = [
-				'id'  => $row['id'],
-				'uri' => $uri,
-				'principaluri' => $principalUriOriginal,
-				'{DAV:}displayname' => $displayName,
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-				'{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal' => $row['principaluri'],
-				$readOnlyPropertyName => $readOnly,
-			];
-
-			$this->addOwnerPrincipal($addressBooks[$row['id']]);
-		}
-		$result->closeCursor();
-
-		return array_values($addressBooks);
-	}
-
-	public function getUsersOwnAddressBooks($principalUri) {
-		$principalUri = $this->convertPrincipal($principalUri, true);
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
-			  ->from('addressbooks')
-			  ->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
-
-		$addressBooks = [];
-
-		$result = $query->execute();
-		while($row = $result->fetch()) {
-			$addressBooks[$row['id']] = [
-				'id'  => $row['id'],
-				'uri' => $row['uri'],
-				'principaluri' => $this->convertPrincipal($row['principaluri'], false),
-				'{DAV:}displayname' => $row['displayname'],
-				'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-				'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-				'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-			];
-
-			$this->addOwnerPrincipal($addressBooks[$row['id']]);
-		}
-		$result->closeCursor();
-
-		return array_values($addressBooks);
-	}
-
-	private function getUserDisplayName($uid) {
-		if (!isset($this->userDisplayNames[$uid])) {
-			$user = $this->userManager->get($uid);
-
-			if ($user instanceof IUser) {
-				$this->userDisplayNames[$uid] = $user->getDisplayName();
-			} else {
-				$this->userDisplayNames[$uid] = $uid;
-			}
-		}
-
-		return $this->userDisplayNames[$uid];
-	}
-
-	/**
-	 * @param int $addressBookId
-	 */
-	public function getAddressBookById($addressBookId) {
-		$query = $this->db->getQueryBuilder();
-		$result = $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
-			->from('addressbooks')
-			->where($query->expr()->eq('id', $query->createNamedParameter($addressBookId)))
-			->execute();
-
-		$row = $result->fetch();
-		$result->closeCursor();
-		if ($row === false) {
-			return null;
-		}
-
-		$addressBook = [
-			'id'  => $row['id'],
-			'uri' => $row['uri'],
-			'principaluri' => $row['principaluri'],
-			'{DAV:}displayname' => $row['displayname'],
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-			'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-			'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-		];
-
-		$this->addOwnerPrincipal($addressBook);
-
-		return $addressBook;
-	}
-
-	/**
-	 * @param $addressBookUri
-	 * @return array|null
-	 */
-	public function getAddressBooksByUri($principal, $addressBookUri) {
-		$query = $this->db->getQueryBuilder();
-		$result = $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
-			->from('addressbooks')
-			->where($query->expr()->eq('uri', $query->createNamedParameter($addressBookUri)))
-			->andWhere($query->expr()->eq('principaluri', $query->createNamedParameter($principal)))
-			->setMaxResults(1)
-			->execute();
-
-		$row = $result->fetch();
-		$result->closeCursor();
-		if ($row === false) {
-			return null;
-		}
-
-		$addressBook = [
-			'id'  => $row['id'],
-			'uri' => $row['uri'],
-			'principaluri' => $row['principaluri'],
-			'{DAV:}displayname' => $row['displayname'],
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
-			'{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
-			'{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
-		];
-
-		$this->addOwnerPrincipal($addressBook);
-
-		return $addressBook;
-	}
-
-	/**
-	 * Updates properties for an address book.
-	 *
-	 * The list of mutations is stored in a Sabre\DAV\PropPatch object.
-	 * To do the actual updates, you must tell this object which properties
-	 * you're going to process with the handle() method.
-	 *
-	 * Calling the handle method is like telling the PropPatch object "I
-	 * promise I can handle updating this property".
-	 *
-	 * Read the PropPatch documentation for more info and examples.
-	 *
-	 * @param string $addressBookId
-	 * @param \Sabre\DAV\PropPatch $propPatch
-	 * @return void
-	 */
-	function updateAddressBook($addressBookId, \Sabre\DAV\PropPatch $propPatch) {
-		$supportedProperties = [
-			'{DAV:}displayname',
-			'{' . Plugin::NS_CARDDAV . '}addressbook-description',
-		];
-
-		/**
-		 * @suppress SqlInjectionChecker
-		 */
-		$propPatch->handle($supportedProperties, function($mutations) use ($addressBookId) {
-
-			$updates = [];
-			foreach($mutations as $property=>$newValue) {
-
-				switch($property) {
-					case '{DAV:}displayname' :
-						$updates['displayname'] = $newValue;
-						break;
-					case '{' . Plugin::NS_CARDDAV . '}addressbook-description' :
-						$updates['description'] = $newValue;
-						break;
-				}
-			}
-			$query = $this->db->getQueryBuilder();
-			$query->update('addressbooks');
-
-			foreach($updates as $key=>$value) {
-				$query->set($key, $query->createNamedParameter($value));
-			}
-			$query->where($query->expr()->eq('id', $query->createNamedParameter($addressBookId)))
-			->execute();
-
-			$this->addChange($addressBookId, "", 2);
-
-			return true;
-
-		});
-	}
-
-	/**
-	 * Creates a new address book
-	 *
-	 * @param string $principalUri
-	 * @param string $url Just the 'basename' of the url.
-	 * @param array $properties
-	 * @return int
-	 * @throws BadRequest
-	 */
-	function createAddressBook($principalUri, $url, array $properties) {
-		$values = [
-			'displayname' => null,
-			'description' => null,
-			'principaluri' => $principalUri,
-			'uri' => $url,
-			'synctoken' => 1
-		];
-
-		foreach($properties as $property=>$newValue) {
-
-			switch($property) {
-				case '{DAV:}displayname' :
-					$values['displayname'] = $newValue;
-					break;
-				case '{' . Plugin::NS_CARDDAV . '}addressbook-description' :
-					$values['description'] = $newValue;
-					break;
-				default :
-					throw new BadRequest('Unknown property: ' . $property);
-			}
-
-		}
-
-		// Fallback to make sure the displayname is set. Some clients may refuse
-		// to work with addressbooks not having a displayname.
-		if(is_null($values['displayname'])) {
-			$values['displayname'] = $url;
-		}
-
-		$query = $this->db->getQueryBuilder();
-		$query->insert('addressbooks')
-			->values([
-				'uri' => $query->createParameter('uri'),
-				'displayname' => $query->createParameter('displayname'),
-				'description' => $query->createParameter('description'),
-				'principaluri' => $query->createParameter('principaluri'),
-				'synctoken' => $query->createParameter('synctoken'),
-			])
-			->setParameters($values)
-			->execute();
-
-		return $query->getLastInsertId();
-	}
-
-	/**
-	 * Deletes an entire addressbook and all its contents
-	 *
-	 * @param mixed $addressBookId
-	 * @return void
-	 */
-	function deleteAddressBook($addressBookId) {
-		$query = $this->db->getQueryBuilder();
-		$query->delete('cards')
-			->where($query->expr()->eq('addressbookid', $query->createParameter('addressbookid')))
-			->setParameter('addressbookid', $addressBookId)
-			->execute();
-
-		$query->delete('addressbookchanges')
-			->where($query->expr()->eq('addressbookid', $query->createParameter('addressbookid')))
-			->setParameter('addressbookid', $addressBookId)
-			->execute();
-
-		$query->delete('addressbooks')
-			->where($query->expr()->eq('id', $query->createParameter('id')))
-			->setParameter('id', $addressBookId)
-			->execute();
-
-		$this->sharingBackend->deleteAllShares($addressBookId);
-
-		$query->delete($this->dbCardsPropertiesTable)
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->execute();
-
-	}
-
-	/**
-	 * Returns all cards for a specific addressbook id.
-	 *
-	 * This method should return the following properties for each card:
-	 *   * carddata - raw vcard data
-	 *   * uri - Some unique url
-	 *   * lastmodified - A unix timestamp
-	 *
-	 * It's recommended to also return the following properties:
-	 *   * etag - A unique etag. This must change every time the card changes.
-	 *   * size - The size of the card in bytes.
-	 *
-	 * If these last two properties are provided, less time will be spent
-	 * calculating them. If they are specified, you can also ommit carddata.
-	 * This may speed up certain requests, especially with large cards.
-	 *
-	 * @param mixed $addressBookId
-	 * @return array
-	 */
-	function getCards($addressBookId) {
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
-			->from('cards')
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
-
-		$cards = [];
-
-		$result = $query->execute();
-		while($row = $result->fetch()) {
-			$row['etag'] = '"' . $row['etag'] . '"';
-			$row['carddata'] = $this->readBlob($row['carddata']);
-			$cards[] = $row;
-		}
-		$result->closeCursor();
-
-		return $cards;
-	}
-
-	/**
-	 * Returns a specific card.
-	 *
-	 * The same set of properties must be returned as with getCards. The only
-	 * exception is that 'carddata' is absolutely required.
-	 *
-	 * If the card does not exist, you must return false.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $cardUri
-	 * @return array
-	 */
-	function getCard($addressBookId, $cardUri) {
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
-			->from('cards')
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->andWhere($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
-			->setMaxResults(1);
-
-		$result = $query->execute();
-		$row = $result->fetch();
-		if (!$row) {
-			return false;
-		}
-		$row['etag'] = '"' . $row['etag'] . '"';
-		$row['carddata'] = $this->readBlob($row['carddata']);
-
-		return $row;
-	}
-
-	/**
-	 * Returns a list of cards.
-	 *
-	 * This method should work identical to getCard, but instead return all the
-	 * cards in the list as an array.
-	 *
-	 * If the backend supports this, it may allow for some speed-ups.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string[] $uris
-	 * @return array
-	 */
-	function getMultipleCards($addressBookId, array $uris) {
-		if (empty($uris)) {
-			return [];
-		}
-
-		$chunks = array_chunk($uris, 100);
-		$cards = [];
-
-		$query = $this->db->getQueryBuilder();
-		$query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
-			->from('cards')
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->andWhere($query->expr()->in('uri', $query->createParameter('uri')));
-
-		foreach ($chunks as $uris) {
-			$query->setParameter('uri', $uris, IQueryBuilder::PARAM_STR_ARRAY);
-			$result = $query->execute();
-
-			while ($row = $result->fetch()) {
-				$row['etag'] = '"' . $row['etag'] . '"';
-				$row['carddata'] = $this->readBlob($row['carddata']);
-				$cards[] = $row;
-			}
-			$result->closeCursor();
-		}
-		return $cards;
-	}
-
-	/**
-	 * Creates a new card.
-	 *
-	 * The addressbook id will be passed as the first argument. This is the
-	 * same id as it is returned from the getAddressBooksForUser method.
-	 *
-	 * The cardUri is a base uri, and doesn't include the full path. The
-	 * cardData argument is the vcard body, and is passed as a string.
-	 *
-	 * It is possible to return an ETag from this method. This ETag is for the
-	 * newly created resource, and must be enclosed with double quotes (that
-	 * is, the string itself must contain the double quotes).
-	 *
-	 * You should only return the ETag if you store the carddata as-is. If a
-	 * subsequent GET request on the same card does not have the same body,
-	 * byte-by-byte and you did return an ETag here, clients tend to get
-	 * confused.
-	 *
-	 * If you don't return an ETag, you can just return null.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $cardUri
-	 * @param string $cardData
-	 * @return string
-	 */
-	function createCard($addressBookId, $cardUri, $cardData) {
-		$etag = md5($cardData);
-		$uid = $this->getUID($cardData);
-
-		$q = $this->db->getQueryBuilder();
-		$q->select('uid')
-			->from('cards')
-			->where($q->expr()->eq('addressbookid', $q->createNamedParameter($addressBookId)))
-			->andWhere($q->expr()->eq('uid', $q->createNamedParameter($uid)))
-			->setMaxResults(1);
-		$result = $q->execute();
-		$count = (bool) $result->fetchColumn();
-		$result->closeCursor();
-		if ($count) {
-			throw new \Sabre\DAV\Exception\BadRequest('VCard object with uid already exists in this addressbook collection.');
-		}
-
-		$query = $this->db->getQueryBuilder();
-		$query->insert('cards')
-			->values([
-				'carddata' => $query->createNamedParameter($cardData, IQueryBuilder::PARAM_LOB),
-				'uri' => $query->createNamedParameter($cardUri),
-				'lastmodified' => $query->createNamedParameter(time()),
-				'addressbookid' => $query->createNamedParameter($addressBookId),
-				'size' => $query->createNamedParameter(strlen($cardData)),
-				'etag' => $query->createNamedParameter($etag),
-				'uid' => $query->createNamedParameter($uid),
-			])
-			->execute();
-
-		$this->addChange($addressBookId, $cardUri, 1);
-		$this->updateProperties($addressBookId, $cardUri, $cardData);
-
-		$this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::createCard',
-			new GenericEvent(null, [
-				'addressBookId' => $addressBookId,
-				'cardUri' => $cardUri,
-				'cardData' => $cardData]));
-
-		return '"' . $etag . '"';
-	}
-
-	/**
-	 * Updates a card.
-	 *
-	 * The addressbook id will be passed as the first argument. This is the
-	 * same id as it is returned from the getAddressBooksForUser method.
-	 *
-	 * The cardUri is a base uri, and doesn't include the full path. The
-	 * cardData argument is the vcard body, and is passed as a string.
-	 *
-	 * It is possible to return an ETag from this method. This ETag should
-	 * match that of the updated resource, and must be enclosed with double
-	 * quotes (that is: the string itself must contain the actual quotes).
-	 *
-	 * You should only return the ETag if you store the carddata as-is. If a
-	 * subsequent GET request on the same card does not have the same body,
-	 * byte-by-byte and you did return an ETag here, clients tend to get
-	 * confused.
-	 *
-	 * If you don't return an ETag, you can just return null.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $cardUri
-	 * @param string $cardData
-	 * @return string
-	 */
-	function updateCard($addressBookId, $cardUri, $cardData) {
-
-		$uid = $this->getUID($cardData);
-		$etag = md5($cardData);
-		$query = $this->db->getQueryBuilder();
-		$query->update('cards')
-			->set('carddata', $query->createNamedParameter($cardData, IQueryBuilder::PARAM_LOB))
-			->set('lastmodified', $query->createNamedParameter(time()))
-			->set('size', $query->createNamedParameter(strlen($cardData)))
-			->set('etag', $query->createNamedParameter($etag))
-			->set('uid', $query->createNamedParameter($uid))
-			->where($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
-			->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->execute();
-
-		$this->addChange($addressBookId, $cardUri, 2);
-		$this->updateProperties($addressBookId, $cardUri, $cardData);
-
-		$this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::updateCard',
-			new GenericEvent(null, [
-				'addressBookId' => $addressBookId,
-				'cardUri' => $cardUri,
-				'cardData' => $cardData]));
-
-		return '"' . $etag . '"';
-	}
-
-	/**
-	 * Deletes a card
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $cardUri
-	 * @return bool
-	 */
-	function deleteCard($addressBookId, $cardUri) {
-		try {
-			$cardId = $this->getCardId($addressBookId, $cardUri);
-		} catch (\InvalidArgumentException $e) {
-			$cardId = null;
-		}
-		$query = $this->db->getQueryBuilder();
-		$ret = $query->delete('cards')
-			->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
-			->andWhere($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
-			->execute();
-
-		$this->addChange($addressBookId, $cardUri, 3);
-
-		$this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::deleteCard',
-			new GenericEvent(null, [
-				'addressBookId' => $addressBookId,
-				'cardUri' => $cardUri]));
-
-		if ($ret === 1) {
-			if ($cardId !== null) {
-				$this->purgeProperties($addressBookId, $cardId);
-			}
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * The getChanges method returns all the changes that have happened, since
-	 * the specified syncToken in the specified address book.
-	 *
-	 * This function should return an array, such as the following:
-	 *
-	 * [
-	 *   'syncToken' => 'The current synctoken',
-	 *   'added'   => [
-	 *      'new.txt',
-	 *   ],
-	 *   'modified'   => [
-	 *      'modified.txt',
-	 *   ],
-	 *   'deleted' => [
-	 *      'foo.php.bak',
-	 *      'old.txt'
-	 *   ]
-	 * ];
-	 *
-	 * The returned syncToken property should reflect the *current* syncToken
-	 * of the calendar, as reported in the {http://sabredav.org/ns}sync-token
-	 * property. This is needed here too, to ensure the operation is atomic.
-	 *
-	 * If the $syncToken argument is specified as null, this is an initial
-	 * sync, and all members should be reported.
-	 *
-	 * The modified property is an array of nodenames that have changed since
-	 * the last token.
-	 *
-	 * The deleted property is an array with nodenames, that have been deleted
-	 * from collection.
-	 *
-	 * The $syncLevel argument is basically the 'depth' of the report. If it's
-	 * 1, you only have to report changes that happened only directly in
-	 * immediate descendants. If it's 2, it should also include changes from
-	 * the nodes below the child collections. (grandchildren)
-	 *
-	 * The $limit argument allows a client to specify how many results should
-	 * be returned at most. If the limit is not specified, it should be treated
-	 * as infinite.
-	 *
-	 * If the limit (infinite or not) is higher than you're willing to return,
-	 * you should throw a Sabre\DAV\Exception\TooMuchMatches() exception.
-	 *
-	 * If the syncToken is expired (due to data cleanup) or unknown, you must
-	 * return null.
-	 *
-	 * The limit is 'suggestive'. You are free to ignore it.
-	 *
-	 * @param string $addressBookId
-	 * @param string $syncToken
-	 * @param int $syncLevel
-	 * @param int $limit
-	 * @return array
-	 */
-	function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel, $limit = null) {
-		// Current synctoken
-		$stmt = $this->db->prepare('SELECT `synctoken` FROM `*PREFIX*addressbooks` WHERE `id` = ?');
-		$stmt->execute([ $addressBookId ]);
-		$currentToken = $stmt->fetchColumn(0);
-
-		if (is_null($currentToken)) return null;
-
-		$result = [
-			'syncToken' => $currentToken,
-			'added'     => [],
-			'modified'  => [],
-			'deleted'   => [],
-		];
-
-		if ($syncToken) {
-
-			$query = "SELECT `uri`, `operation` FROM `*PREFIX*addressbookchanges` WHERE `synctoken` >= ? AND `synctoken` < ? AND `addressbookid` = ? ORDER BY `synctoken`";
-			if ($limit>0) {
-				$query .= " LIMIT " . (int)$limit;
-			}
-
-			// Fetching all changes
-			$stmt = $this->db->prepare($query);
-			$stmt->execute([$syncToken, $currentToken, $addressBookId]);
-
-			$changes = [];
-
-			// This loop ensures that any duplicates are overwritten, only the
-			// last change on a node is relevant.
-			while($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
-
-				$changes[$row['uri']] = $row['operation'];
-
-			}
-
-			foreach($changes as $uri => $operation) {
-
-				switch($operation) {
-					case 1:
-						$result['added'][] = $uri;
-						break;
-					case 2:
-						$result['modified'][] = $uri;
-						break;
-					case 3:
-						$result['deleted'][] = $uri;
-						break;
-				}
-
-			}
-		} else {
-			// No synctoken supplied, this is the initial sync.
-			$query = "SELECT `uri` FROM `*PREFIX*cards` WHERE `addressbookid` = ?";
-			$stmt = $this->db->prepare($query);
-			$stmt->execute([$addressBookId]);
-
-			$result['added'] = $stmt->fetchAll(\PDO::FETCH_COLUMN);
-		}
-		return $result;
-	}
-
-	/**
-	 * Adds a change record to the addressbookchanges table.
-	 *
-	 * @param mixed $addressBookId
-	 * @param string $objectUri
-	 * @param int $operation 1 = add, 2 = modify, 3 = delete
-	 * @return void
-	 */
-	protected function addChange($addressBookId, $objectUri, $operation) {
-		$sql = 'INSERT INTO `*PREFIX*addressbookchanges`(`uri`, `synctoken`, `addressbookid`, `operation`) SELECT ?, `synctoken`, ?, ? FROM `*PREFIX*addressbooks` WHERE `id` = ?';
-		$stmt = $this->db->prepare($sql);
-		$stmt->execute([
-			$objectUri,
-			$addressBookId,
-			$operation,
-			$addressBookId
-		]);
-		$stmt = $this->db->prepare('UPDATE `*PREFIX*addressbooks` SET `synctoken` = `synctoken` + 1 WHERE `id` = ?');
-		$stmt->execute([
-			$addressBookId
-		]);
-	}
-
-	private function readBlob($cardData) {
-		if (is_resource($cardData)) {
-			return stream_get_contents($cardData);
-		}
-
-		return $cardData;
-	}
-
-	/**
-	 * @param IShareable $shareable
-	 * @param string[] $add
-	 * @param string[] $remove
-	 */
-	public function updateShares(IShareable $shareable, $add, $remove) {
-		$this->sharingBackend->updateShares($shareable, $add, $remove);
-	}
-
-	/**
-	 * search contact
-	 *
-	 * @param int $addressBookId
-	 * @param string $pattern which should match within the $searchProperties
-	 * @param array $searchProperties defines the properties within the query pattern should match
-	 * @param array $options = array() to define the search behavior
-	 * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped, otherwise they are
-	 * @return array an array of contacts which are arrays of key-value-pairs
-	 */
-	public function search($addressBookId, $pattern, $searchProperties, $options = []) {
-		$query = $this->db->getQueryBuilder();
-		$query2 = $this->db->getQueryBuilder();
-
-		$query2->selectDistinct('cp.cardid')->from($this->dbCardsPropertiesTable, 'cp');
-		$query2->andWhere($query2->expr()->eq('cp.addressbookid', $query->createNamedParameter($addressBookId)));
-		$or = $query2->expr()->orX();
-		foreach ($searchProperties as $property) {
-			$or->add($query2->expr()->eq('cp.name', $query->createNamedParameter($property)));
-		}
-		$query2->andWhere($or);
-
-		// No need for like when the pattern is empty
-		if ('' !== $pattern) {
-			if(\array_key_exists('escape_like_param', $options) && $options['escape_like_param'] === false) {
-				$query2->andWhere($query2->expr()->ilike('cp.value', $query->createNamedParameter($pattern)));
-			} else {
-				$query2->andWhere($query2->expr()->ilike('cp.value', $query->createNamedParameter('%' . $this->db->escapeLikeParameter($pattern) . '%')));
-			}
-		}
-
-		$query->select('c.carddata', 'c.uri')->from($this->dbCardsTable, 'c')
-			->where($query->expr()->in('c.id', $query->createFunction($query2->getSQL())));
-
-		$result = $query->execute();
-		$cards = $result->fetchAll();
-
-		$result->closeCursor();
-
-		return array_map(function($array) {
-			$array['carddata'] = $this->readBlob($array['carddata']);
-			return $array;
-		}, $cards);
-	}
-
-	/**
-	 * @param int $bookId
-	 * @param string $name
-	 * @return array
-	 */
-	public function collectCardProperties($bookId, $name) {
-		$query = $this->db->getQueryBuilder();
-		$result = $query->selectDistinct('value')
-			->from($this->dbCardsPropertiesTable)
-			->where($query->expr()->eq('name', $query->createNamedParameter($name)))
-			->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($bookId)))
-			->execute();
-
-		$all = $result->fetchAll(PDO::FETCH_COLUMN);
-		$result->closeCursor();
-
-		return $all;
-	}
-
-	/**
-	 * get URI from a given contact
-	 *
-	 * @param int $id
-	 * @return string
-	 */
-	public function getCardUri($id) {
-		$query = $this->db->getQueryBuilder();
-		$query->select('uri')->from($this->dbCardsTable)
-				->where($query->expr()->eq('id', $query->createParameter('id')))
-				->setParameter('id', $id);
-
-		$result = $query->execute();
-		$uri = $result->fetch();
-		$result->closeCursor();
-
-		if (!isset($uri['uri'])) {
-			throw new \InvalidArgumentException('Card does not exists: ' . $id);
-		}
-
-		return $uri['uri'];
-	}
-
-	/**
-	 * return contact with the given URI
-	 *
-	 * @param int $addressBookId
-	 * @param string $uri
-	 * @returns array
-	 */
-	public function getContact($addressBookId, $uri) {
-		$result = [];
-		$query = $this->db->getQueryBuilder();
-		$query->select('*')->from($this->dbCardsTable)
-				->where($query->expr()->eq('uri', $query->createNamedParameter($uri)))
-				->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
-		$queryResult = $query->execute();
-		$contact = $queryResult->fetch();
-		$queryResult->closeCursor();
-
-		if (is_array($contact)) {
-			$result = $contact;
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Returns the list of people whom this address book is shared with.
-	 *
-	 * Every element in this array should have the following properties:
-	 *   * href - Often a mailto: address
-	 *   * commonName - Optional, for example a first + last name
-	 *   * status - See the Sabre\CalDAV\SharingPlugin::STATUS_ constants.
-	 *   * readOnly - boolean
-	 *   * summary - Optional, a description for the share
-	 *
-	 * @return array
-	 */
-	public function getShares($addressBookId) {
-		return $this->sharingBackend->getShares($addressBookId);
-	}
-
-	/**
-	 * update properties table
-	 *
-	 * @param int $addressBookId
-	 * @param string $cardUri
-	 * @param string $vCardSerialized
-	 */
-	protected function updateProperties($addressBookId, $cardUri, $vCardSerialized) {
-		$cardId = $this->getCardId($addressBookId, $cardUri);
-		$vCard = $this->readCard($vCardSerialized);
-
-		$this->purgeProperties($addressBookId, $cardId);
-
-		$query = $this->db->getQueryBuilder();
-		$query->insert($this->dbCardsPropertiesTable)
-			->values(
-				[
-					'addressbookid' => $query->createNamedParameter($addressBookId),
-					'cardid' => $query->createNamedParameter($cardId),
-					'name' => $query->createParameter('name'),
-					'value' => $query->createParameter('value'),
-					'preferred' => $query->createParameter('preferred')
-				]
-			);
-
-		foreach ($vCard->children() as $property) {
-			if(!in_array($property->name, self::$indexProperties)) {
-				continue;
-			}
-			$preferred = 0;
-			foreach($property->parameters as $parameter) {
-				if ($parameter->name === 'TYPE' && strtoupper($parameter->getValue()) === 'PREF') {
-					$preferred = 1;
-					break;
-				}
-			}
-			$query->setParameter('name', $property->name);
-			$query->setParameter('value', mb_substr($property->getValue(), 0, 254));
-			$query->setParameter('preferred', $preferred);
-			$query->execute();
-		}
-	}
-
-	/**
-	 * read vCard data into a vCard object
-	 *
-	 * @param string $cardData
-	 * @return VCard
-	 */
-	protected function readCard($cardData) {
-		return  Reader::read($cardData);
-	}
-
-	/**
-	 * delete all properties from a given card
-	 *
-	 * @param int $addressBookId
-	 * @param int $cardId
-	 */
-	protected function purgeProperties($addressBookId, $cardId) {
-		$query = $this->db->getQueryBuilder();
-		$query->delete($this->dbCardsPropertiesTable)
-			->where($query->expr()->eq('cardid', $query->createNamedParameter($cardId)))
-			->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
-		$query->execute();
-	}
-
-	/**
-	 * get ID from a given contact
-	 *
-	 * @param int $addressBookId
-	 * @param string $uri
-	 * @return int
-	 */
-	protected function getCardId($addressBookId, $uri) {
-		$query = $this->db->getQueryBuilder();
-		$query->select('id')->from($this->dbCardsTable)
-			->where($query->expr()->eq('uri', $query->createNamedParameter($uri)))
-			->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
-
-		$result = $query->execute();
-		$cardIds = $result->fetch();
-		$result->closeCursor();
-
-		if (!isset($cardIds['id'])) {
-			throw new \InvalidArgumentException('Card does not exists: ' . $uri);
-		}
-
-		return (int)$cardIds['id'];
-	}
-
-	/**
-	 * For shared address books the sharee is set in the ACL of the address book
-	 * @param $addressBookId
-	 * @param $acl
-	 * @return array
-	 */
-	public function applyShareAcl($addressBookId, $acl) {
-		return $this->sharingBackend->applyShareAcl($addressBookId, $acl);
-	}
-
-	private function convertPrincipal($principalUri, $toV2) {
-		if ($this->principalBackend->getPrincipalPrefix() === 'principals') {
-			list(, $name) = \Sabre\Uri\split($principalUri);
-			if ($toV2 === true) {
-				return "principals/users/$name";
-			}
-			return "principals/$name";
-		}
-		return $principalUri;
-	}
-
-	private function addOwnerPrincipal(&$addressbookInfo) {
-		$ownerPrincipalKey = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal';
-		$displaynameKey = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_NEXTCLOUD . '}owner-displayname';
-		if (isset($addressbookInfo[$ownerPrincipalKey])) {
-			$uri = $addressbookInfo[$ownerPrincipalKey];
-		} else {
-			$uri = $addressbookInfo['principaluri'];
-		}
-
-		$principalInformation = $this->principalBackend->getPrincipalByPath($uri);
-		if (isset($principalInformation['{DAV:}displayname'])) {
-			$addressbookInfo[$displaynameKey] = $principalInformation['{DAV:}displayname'];
-		}
-	}
-
-	/**
-	 * Extract UID from vcard
-	 *
-	 * @param string $cardData the vcard raw data
-	 * @return string the uid
-	 * @throws BadRequest if no UID is available
-	 */
-	private function getUID($cardData) {
-		if ($cardData != '') {
-			$vCard = Reader::read($cardData);
-			if ($vCard->UID) {
-				$uid = $vCard->UID->getValue();
-				return $uid;
-			}
-			// should already be handled, but just in case
-			throw new BadRequest('vCards on CardDAV servers MUST have a UID property');
-		}
-		// should already be handled, but just in case
-		throw new BadRequest('vCard can not be empty');
-	}
+    const PERSONAL_ADDRESSBOOK_URI = 'contacts';
+    const PERSONAL_ADDRESSBOOK_NAME = 'Contacts';
+
+    /** @var Principal */
+    private $principalBackend;
+
+    /** @var string */
+    private $dbCardsTable = 'cards';
+
+    /** @var string */
+    private $dbCardsPropertiesTable = 'cards_properties';
+
+    /** @var IDBConnection */
+    private $db;
+
+    /** @var Backend */
+    private $sharingBackend;
+
+    /** @var array properties to index */
+    public static $indexProperties = [
+            'BDAY', 'UID', 'N', 'FN', 'TITLE', 'ROLE', 'NOTE', 'NICKNAME',
+            'ORG', 'CATEGORIES', 'EMAIL', 'TEL', 'IMPP', 'ADR', 'URL', 'GEO', 'CLOUD'];
+
+    /**
+     * @var string[] Map of uid => display name
+     */
+    protected $userDisplayNames;
+
+    /** @var IUserManager */
+    private $userManager;
+
+    /** @var EventDispatcherInterface */
+    private $dispatcher;
+
+    /**
+     * CardDavBackend constructor.
+     *
+     * @param IDBConnection $db
+     * @param Principal $principalBackend
+     * @param IUserManager $userManager
+     * @param IGroupManager $groupManager
+     * @param EventDispatcherInterface $dispatcher
+     */
+    public function __construct(IDBConnection $db,
+                                Principal $principalBackend,
+                                IUserManager $userManager,
+                                IGroupManager $groupManager,
+                                EventDispatcherInterface $dispatcher) {
+        $this->db = $db;
+        $this->principalBackend = $principalBackend;
+        $this->userManager = $userManager;
+        $this->dispatcher = $dispatcher;
+        $this->sharingBackend = new Backend($this->db, $this->userManager, $groupManager, $principalBackend, 'addressbook');
+    }
+
+    /**
+     * Return the number of address books for a principal
+     *
+     * @param $principalUri
+     * @return int
+     */
+    public function getAddressBooksForUserCount($principalUri) {
+        $principalUri = $this->convertPrincipal($principalUri, true);
+        $query = $this->db->getQueryBuilder();
+        $query->select($query->func()->count('*'))
+            ->from('addressbooks')
+            ->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
+
+        return (int)$query->execute()->fetchColumn();
+    }
+
+    /**
+     * Returns the list of address books for a specific user.
+     *
+     * Every addressbook should have the following properties:
+     *   id - an arbitrary unique id
+     *   uri - the 'basename' part of the url
+     *   principaluri - Same as the passed parameter
+     *
+     * Any additional clark-notation property may be passed besides this. Some
+     * common ones are :
+     *   {DAV:}displayname
+     *   {urn:ietf:params:xml:ns:carddav}addressbook-description
+     *   {http://calendarserver.org/ns/}getctag
+     *
+     * @param string $principalUri
+     * @return array
+     */
+    function getAddressBooksForUser($principalUri) {
+        $principalUriOriginal = $principalUri;
+        $principalUri = $this->convertPrincipal($principalUri, true);
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
+            ->from('addressbooks')
+            ->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
+
+        $addressBooks = [];
+
+        $result = $query->execute();
+        while($row = $result->fetch()) {
+            $addressBooks[$row['id']] = [
+                'id'  => $row['id'],
+                'uri' => $row['uri'],
+                'principaluri' => $this->convertPrincipal($row['principaluri'], false),
+                '{DAV:}displayname' => $row['displayname'],
+                '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+                '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+                '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+            ];
+
+            $this->addOwnerPrincipal($addressBooks[$row['id']]);
+        }
+        $result->closeCursor();
+
+        // query for shared addressbooks
+        $principals = $this->principalBackend->getGroupMembership($principalUriOriginal, true);
+        $principals = array_merge($principals, $this->principalBackend->getCircleMembership($principalUriOriginal));
+
+        $principals = array_map(function($principal) {
+            return urldecode($principal);
+        }, $principals);
+        $principals[]= $principalUri;
+
+        $query = $this->db->getQueryBuilder();
+        $result = $query->select(['a.id', 'a.uri', 'a.displayname', 'a.principaluri', 'a.description', 'a.synctoken', 's.access'])
+            ->from('dav_shares', 's')
+            ->join('s', 'addressbooks', 'a', $query->expr()->eq('s.resourceid', 'a.id'))
+            ->where($query->expr()->in('s.principaluri', $query->createParameter('principaluri')))
+            ->andWhere($query->expr()->eq('s.type', $query->createParameter('type')))
+            ->setParameter('type', 'addressbook')
+            ->setParameter('principaluri', $principals, IQueryBuilder::PARAM_STR_ARRAY)
+            ->execute();
+
+        $readOnlyPropertyName = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}read-only';
+        while($row = $result->fetch()) {
+            if ($row['principaluri'] === $principalUri) {
+                continue;
+            }
+
+            $readOnly = (int) $row['access'] === Backend::ACCESS_READ;
+            if (isset($addressBooks[$row['id']])) {
+                if ($readOnly) {
+                    // New share can not have more permissions then the old one.
+                    continue;
+                }
+                if (isset($addressBooks[$row['id']][$readOnlyPropertyName]) &&
+                    $addressBooks[$row['id']][$readOnlyPropertyName] === 0) {
+                    // Old share is already read-write, no more permissions can be gained
+                    continue;
+                }
+            }
+
+            list(, $name) = \Sabre\Uri\split($row['principaluri']);
+            $uri = $row['uri'] . '_shared_by_' . $name;
+            $displayName = $row['displayname'] . ' (' . $this->getUserDisplayName($name) . ')';
+
+            $addressBooks[$row['id']] = [
+                'id'  => $row['id'],
+                'uri' => $uri,
+                'principaluri' => $principalUriOriginal,
+                '{DAV:}displayname' => $displayName,
+                '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+                '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+                '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+                '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal' => $row['principaluri'],
+                $readOnlyPropertyName => $readOnly,
+            ];
+
+            $this->addOwnerPrincipal($addressBooks[$row['id']]);
+        }
+        $result->closeCursor();
+
+        return array_values($addressBooks);
+    }
+
+    public function getUsersOwnAddressBooks($principalUri) {
+        $principalUri = $this->convertPrincipal($principalUri, true);
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
+                ->from('addressbooks')
+                ->where($query->expr()->eq('principaluri', $query->createNamedParameter($principalUri)));
+
+        $addressBooks = [];
+
+        $result = $query->execute();
+        while($row = $result->fetch()) {
+            $addressBooks[$row['id']] = [
+                'id'  => $row['id'],
+                'uri' => $row['uri'],
+                'principaluri' => $this->convertPrincipal($row['principaluri'], false),
+                '{DAV:}displayname' => $row['displayname'],
+                '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+                '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+                '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+            ];
+
+            $this->addOwnerPrincipal($addressBooks[$row['id']]);
+        }
+        $result->closeCursor();
+
+        return array_values($addressBooks);
+    }
+
+    private function getUserDisplayName($uid) {
+        if (!isset($this->userDisplayNames[$uid])) {
+            $user = $this->userManager->get($uid);
+
+            if ($user instanceof IUser) {
+                $this->userDisplayNames[$uid] = $user->getDisplayName();
+            } else {
+                $this->userDisplayNames[$uid] = $uid;
+            }
+        }
+
+        return $this->userDisplayNames[$uid];
+    }
+
+    /**
+     * @param int $addressBookId
+     */
+    public function getAddressBookById($addressBookId) {
+        $query = $this->db->getQueryBuilder();
+        $result = $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
+            ->from('addressbooks')
+            ->where($query->expr()->eq('id', $query->createNamedParameter($addressBookId)))
+            ->execute();
+
+        $row = $result->fetch();
+        $result->closeCursor();
+        if ($row === false) {
+            return null;
+        }
+
+        $addressBook = [
+            'id'  => $row['id'],
+            'uri' => $row['uri'],
+            'principaluri' => $row['principaluri'],
+            '{DAV:}displayname' => $row['displayname'],
+            '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+            '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+            '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+        ];
+
+        $this->addOwnerPrincipal($addressBook);
+
+        return $addressBook;
+    }
+
+    /**
+     * @param $addressBookUri
+     * @return array|null
+     */
+    public function getAddressBooksByUri($principal, $addressBookUri) {
+        $query = $this->db->getQueryBuilder();
+        $result = $query->select(['id', 'uri', 'displayname', 'principaluri', 'description', 'synctoken'])
+            ->from('addressbooks')
+            ->where($query->expr()->eq('uri', $query->createNamedParameter($addressBookUri)))
+            ->andWhere($query->expr()->eq('principaluri', $query->createNamedParameter($principal)))
+            ->setMaxResults(1)
+            ->execute();
+
+        $row = $result->fetch();
+        $result->closeCursor();
+        if ($row === false) {
+            return null;
+        }
+
+        $addressBook = [
+            'id'  => $row['id'],
+            'uri' => $row['uri'],
+            'principaluri' => $row['principaluri'],
+            '{DAV:}displayname' => $row['displayname'],
+            '{' . Plugin::NS_CARDDAV . '}addressbook-description' => $row['description'],
+            '{http://calendarserver.org/ns/}getctag' => $row['synctoken'],
+            '{http://sabredav.org/ns}sync-token' => $row['synctoken']?$row['synctoken']:'0',
+        ];
+
+        $this->addOwnerPrincipal($addressBook);
+
+        return $addressBook;
+    }
+
+    /**
+     * Updates properties for an address book.
+     *
+     * The list of mutations is stored in a Sabre\DAV\PropPatch object.
+     * To do the actual updates, you must tell this object which properties
+     * you're going to process with the handle() method.
+     *
+     * Calling the handle method is like telling the PropPatch object "I
+     * promise I can handle updating this property".
+     *
+     * Read the PropPatch documentation for more info and examples.
+     *
+     * @param string $addressBookId
+     * @param \Sabre\DAV\PropPatch $propPatch
+     * @return void
+     */
+    function updateAddressBook($addressBookId, \Sabre\DAV\PropPatch $propPatch) {
+        $supportedProperties = [
+            '{DAV:}displayname',
+            '{' . Plugin::NS_CARDDAV . '}addressbook-description',
+        ];
+
+        /**
+         * @suppress SqlInjectionChecker
+         */
+        $propPatch->handle($supportedProperties, function($mutations) use ($addressBookId) {
+
+            $updates = [];
+            foreach($mutations as $property=>$newValue) {
+
+                switch($property) {
+                    case '{DAV:}displayname' :
+                        $updates['displayname'] = $newValue;
+                        break;
+                    case '{' . Plugin::NS_CARDDAV . '}addressbook-description' :
+                        $updates['description'] = $newValue;
+                        break;
+                }
+            }
+            $query = $this->db->getQueryBuilder();
+            $query->update('addressbooks');
+
+            foreach($updates as $key=>$value) {
+                $query->set($key, $query->createNamedParameter($value));
+            }
+            $query->where($query->expr()->eq('id', $query->createNamedParameter($addressBookId)))
+            ->execute();
+
+            $this->addChange($addressBookId, "", 2);
+
+            return true;
+
+        });
+    }
+
+    /**
+     * Creates a new address book
+     *
+     * @param string $principalUri
+     * @param string $url Just the 'basename' of the url.
+     * @param array $properties
+     * @return int
+     * @throws BadRequest
+     */
+    function createAddressBook($principalUri, $url, array $properties) {
+        $values = [
+            'displayname' => null,
+            'description' => null,
+            'principaluri' => $principalUri,
+            'uri' => $url,
+            'synctoken' => 1
+        ];
+
+        foreach($properties as $property=>$newValue) {
+
+            switch($property) {
+                case '{DAV:}displayname' :
+                    $values['displayname'] = $newValue;
+                    break;
+                case '{' . Plugin::NS_CARDDAV . '}addressbook-description' :
+                    $values['description'] = $newValue;
+                    break;
+                default :
+                    throw new BadRequest('Unknown property: ' . $property);
+            }
+
+        }
+
+        // Fallback to make sure the displayname is set. Some clients may refuse
+        // to work with addressbooks not having a displayname.
+        if(is_null($values['displayname'])) {
+            $values['displayname'] = $url;
+        }
+
+        $query = $this->db->getQueryBuilder();
+        $query->insert('addressbooks')
+            ->values([
+                'uri' => $query->createParameter('uri'),
+                'displayname' => $query->createParameter('displayname'),
+                'description' => $query->createParameter('description'),
+                'principaluri' => $query->createParameter('principaluri'),
+                'synctoken' => $query->createParameter('synctoken'),
+            ])
+            ->setParameters($values)
+            ->execute();
+
+        return $query->getLastInsertId();
+    }
+
+    /**
+     * Deletes an entire addressbook and all its contents
+     *
+     * @param mixed $addressBookId
+     * @return void
+     */
+    function deleteAddressBook($addressBookId) {
+        $query = $this->db->getQueryBuilder();
+        $query->delete('cards')
+            ->where($query->expr()->eq('addressbookid', $query->createParameter('addressbookid')))
+            ->setParameter('addressbookid', $addressBookId)
+            ->execute();
+
+        $query->delete('addressbookchanges')
+            ->where($query->expr()->eq('addressbookid', $query->createParameter('addressbookid')))
+            ->setParameter('addressbookid', $addressBookId)
+            ->execute();
+
+        $query->delete('addressbooks')
+            ->where($query->expr()->eq('id', $query->createParameter('id')))
+            ->setParameter('id', $addressBookId)
+            ->execute();
+
+        $this->sharingBackend->deleteAllShares($addressBookId);
+
+        $query->delete($this->dbCardsPropertiesTable)
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->execute();
+
+    }
+
+    /**
+     * Returns all cards for a specific addressbook id.
+     *
+     * This method should return the following properties for each card:
+     *   * carddata - raw vcard data
+     *   * uri - Some unique url
+     *   * lastmodified - A unix timestamp
+     *
+     * It's recommended to also return the following properties:
+     *   * etag - A unique etag. This must change every time the card changes.
+     *   * size - The size of the card in bytes.
+     *
+     * If these last two properties are provided, less time will be spent
+     * calculating them. If they are specified, you can also ommit carddata.
+     * This may speed up certain requests, especially with large cards.
+     *
+     * @param mixed $addressBookId
+     * @return array
+     */
+    function getCards($addressBookId) {
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
+            ->from('cards')
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
+
+        $cards = [];
+
+        $result = $query->execute();
+        while($row = $result->fetch()) {
+            $row['etag'] = '"' . $row['etag'] . '"';
+            $row['carddata'] = $this->readBlob($row['carddata']);
+            $cards[] = $row;
+        }
+        $result->closeCursor();
+
+        return $cards;
+    }
+
+    /**
+     * Returns a specific card.
+     *
+     * The same set of properties must be returned as with getCards. The only
+     * exception is that 'carddata' is absolutely required.
+     *
+     * If the card does not exist, you must return false.
+     *
+     * @param mixed $addressBookId
+     * @param string $cardUri
+     * @return array
+     */
+    function getCard($addressBookId, $cardUri) {
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
+            ->from('cards')
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->andWhere($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
+            ->setMaxResults(1);
+
+        $result = $query->execute();
+        $row = $result->fetch();
+        if (!$row) {
+            return false;
+        }
+        $row['etag'] = '"' . $row['etag'] . '"';
+        $row['carddata'] = $this->readBlob($row['carddata']);
+
+        return $row;
+    }
+
+    /**
+     * Returns a list of cards.
+     *
+     * This method should work identical to getCard, but instead return all the
+     * cards in the list as an array.
+     *
+     * If the backend supports this, it may allow for some speed-ups.
+     *
+     * @param mixed $addressBookId
+     * @param string[] $uris
+     * @return array
+     */
+    function getMultipleCards($addressBookId, array $uris) {
+        if (empty($uris)) {
+            return [];
+        }
+
+        $chunks = array_chunk($uris, 100);
+        $cards = [];
+
+        $query = $this->db->getQueryBuilder();
+        $query->select(['id', 'uri', 'lastmodified', 'etag', 'size', 'carddata', 'uid'])
+            ->from('cards')
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->andWhere($query->expr()->in('uri', $query->createParameter('uri')));
+
+        foreach ($chunks as $uris) {
+            $query->setParameter('uri', $uris, IQueryBuilder::PARAM_STR_ARRAY);
+            $result = $query->execute();
+
+            while ($row = $result->fetch()) {
+                $row['etag'] = '"' . $row['etag'] . '"';
+                $row['carddata'] = $this->readBlob($row['carddata']);
+                $cards[] = $row;
+            }
+            $result->closeCursor();
+        }
+        return $cards;
+    }
+
+    /**
+     * Creates a new card.
+     *
+     * The addressbook id will be passed as the first argument. This is the
+     * same id as it is returned from the getAddressBooksForUser method.
+     *
+     * The cardUri is a base uri, and doesn't include the full path. The
+     * cardData argument is the vcard body, and is passed as a string.
+     *
+     * It is possible to return an ETag from this method. This ETag is for the
+     * newly created resource, and must be enclosed with double quotes (that
+     * is, the string itself must contain the double quotes).
+     *
+     * You should only return the ETag if you store the carddata as-is. If a
+     * subsequent GET request on the same card does not have the same body,
+     * byte-by-byte and you did return an ETag here, clients tend to get
+     * confused.
+     *
+     * If you don't return an ETag, you can just return null.
+     *
+     * @param mixed $addressBookId
+     * @param string $cardUri
+     * @param string $cardData
+     * @return string
+     */
+    function createCard($addressBookId, $cardUri, $cardData) {
+        $etag = md5($cardData);
+        $uid = $this->getUID($cardData);
+
+        $q = $this->db->getQueryBuilder();
+        $q->select('uid')
+            ->from('cards')
+            ->where($q->expr()->eq('addressbookid', $q->createNamedParameter($addressBookId)))
+            ->andWhere($q->expr()->eq('uid', $q->createNamedParameter($uid)))
+            ->setMaxResults(1);
+        $result = $q->execute();
+        $count = (bool) $result->fetchColumn();
+        $result->closeCursor();
+        if ($count) {
+            throw new \Sabre\DAV\Exception\BadRequest('VCard object with uid already exists in this addressbook collection.');
+        }
+
+        $query = $this->db->getQueryBuilder();
+        $query->insert('cards')
+            ->values([
+                'carddata' => $query->createNamedParameter($cardData, IQueryBuilder::PARAM_LOB),
+                'uri' => $query->createNamedParameter($cardUri),
+                'lastmodified' => $query->createNamedParameter(time()),
+                'addressbookid' => $query->createNamedParameter($addressBookId),
+                'size' => $query->createNamedParameter(strlen($cardData)),
+                'etag' => $query->createNamedParameter($etag),
+                'uid' => $query->createNamedParameter($uid),
+            ])
+            ->execute();
+
+        $this->addChange($addressBookId, $cardUri, 1);
+        $this->updateProperties($addressBookId, $cardUri, $cardData);
+
+        $this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::createCard',
+            new GenericEvent(null, [
+                'addressBookId' => $addressBookId,
+                'cardUri' => $cardUri,
+                'cardData' => $cardData]));
+
+        return '"' . $etag . '"';
+    }
+
+    /**
+     * Updates a card.
+     *
+     * The addressbook id will be passed as the first argument. This is the
+     * same id as it is returned from the getAddressBooksForUser method.
+     *
+     * The cardUri is a base uri, and doesn't include the full path. The
+     * cardData argument is the vcard body, and is passed as a string.
+     *
+     * It is possible to return an ETag from this method. This ETag should
+     * match that of the updated resource, and must be enclosed with double
+     * quotes (that is: the string itself must contain the actual quotes).
+     *
+     * You should only return the ETag if you store the carddata as-is. If a
+     * subsequent GET request on the same card does not have the same body,
+     * byte-by-byte and you did return an ETag here, clients tend to get
+     * confused.
+     *
+     * If you don't return an ETag, you can just return null.
+     *
+     * @param mixed $addressBookId
+     * @param string $cardUri
+     * @param string $cardData
+     * @return string
+     */
+    function updateCard($addressBookId, $cardUri, $cardData) {
+
+        $uid = $this->getUID($cardData);
+        $etag = md5($cardData);
+        $query = $this->db->getQueryBuilder();
+        $query->update('cards')
+            ->set('carddata', $query->createNamedParameter($cardData, IQueryBuilder::PARAM_LOB))
+            ->set('lastmodified', $query->createNamedParameter(time()))
+            ->set('size', $query->createNamedParameter(strlen($cardData)))
+            ->set('etag', $query->createNamedParameter($etag))
+            ->set('uid', $query->createNamedParameter($uid))
+            ->where($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
+            ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->execute();
+
+        $this->addChange($addressBookId, $cardUri, 2);
+        $this->updateProperties($addressBookId, $cardUri, $cardData);
+
+        $this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::updateCard',
+            new GenericEvent(null, [
+                'addressBookId' => $addressBookId,
+                'cardUri' => $cardUri,
+                'cardData' => $cardData]));
+
+        return '"' . $etag . '"';
+    }
+
+    /**
+     * Deletes a card
+     *
+     * @param mixed $addressBookId
+     * @param string $cardUri
+     * @return bool
+     */
+    function deleteCard($addressBookId, $cardUri) {
+        try {
+            $cardId = $this->getCardId($addressBookId, $cardUri);
+        } catch (\InvalidArgumentException $e) {
+            $cardId = null;
+        }
+        $query = $this->db->getQueryBuilder();
+        $ret = $query->delete('cards')
+            ->where($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)))
+            ->andWhere($query->expr()->eq('uri', $query->createNamedParameter($cardUri)))
+            ->execute();
+
+        $this->addChange($addressBookId, $cardUri, 3);
+
+        $this->dispatcher->dispatch('\OCA\DAV\CardDAV\CardDavBackend::deleteCard',
+            new GenericEvent(null, [
+                'addressBookId' => $addressBookId,
+                'cardUri' => $cardUri]));
+
+        if ($ret === 1) {
+            if ($cardId !== null) {
+                $this->purgeProperties($addressBookId, $cardId);
+            }
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * The getChanges method returns all the changes that have happened, since
+     * the specified syncToken in the specified address book.
+     *
+     * This function should return an array, such as the following:
+     *
+     * [
+     *   'syncToken' => 'The current synctoken',
+     *   'added'   => [
+     *      'new.txt',
+     *   ],
+     *   'modified'   => [
+     *      'modified.txt',
+     *   ],
+     *   'deleted' => [
+     *      'foo.php.bak',
+     *      'old.txt'
+     *   ]
+     * ];
+     *
+     * The returned syncToken property should reflect the *current* syncToken
+     * of the calendar, as reported in the {http://sabredav.org/ns}sync-token
+     * property. This is needed here too, to ensure the operation is atomic.
+     *
+     * If the $syncToken argument is specified as null, this is an initial
+     * sync, and all members should be reported.
+     *
+     * The modified property is an array of nodenames that have changed since
+     * the last token.
+     *
+     * The deleted property is an array with nodenames, that have been deleted
+     * from collection.
+     *
+     * The $syncLevel argument is basically the 'depth' of the report. If it's
+     * 1, you only have to report changes that happened only directly in
+     * immediate descendants. If it's 2, it should also include changes from
+     * the nodes below the child collections. (grandchildren)
+     *
+     * The $limit argument allows a client to specify how many results should
+     * be returned at most. If the limit is not specified, it should be treated
+     * as infinite.
+     *
+     * If the limit (infinite or not) is higher than you're willing to return,
+     * you should throw a Sabre\DAV\Exception\TooMuchMatches() exception.
+     *
+     * If the syncToken is expired (due to data cleanup) or unknown, you must
+     * return null.
+     *
+     * The limit is 'suggestive'. You are free to ignore it.
+     *
+     * @param string $addressBookId
+     * @param string $syncToken
+     * @param int $syncLevel
+     * @param int $limit
+     * @return array
+     */
+    function getChangesForAddressBook($addressBookId, $syncToken, $syncLevel, $limit = null) {
+        // Current synctoken
+        $stmt = $this->db->prepare('SELECT `synctoken` FROM `*PREFIX*addressbooks` WHERE `id` = ?');
+        $stmt->execute([ $addressBookId ]);
+        $currentToken = $stmt->fetchColumn(0);
+
+        if (is_null($currentToken)) return null;
+
+        $result = [
+            'syncToken' => $currentToken,
+            'added'     => [],
+            'modified'  => [],
+            'deleted'   => [],
+        ];
+
+        if ($syncToken) {
+
+            $query = "SELECT `uri`, `operation` FROM `*PREFIX*addressbookchanges` WHERE `synctoken` >= ? AND `synctoken` < ? AND `addressbookid` = ? ORDER BY `synctoken`";
+            if ($limit>0) {
+                $query .= " LIMIT " . (int)$limit;
+            }
+
+            // Fetching all changes
+            $stmt = $this->db->prepare($query);
+            $stmt->execute([$syncToken, $currentToken, $addressBookId]);
+
+            $changes = [];
+
+            // This loop ensures that any duplicates are overwritten, only the
+            // last change on a node is relevant.
+            while($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
+
+                $changes[$row['uri']] = $row['operation'];
+
+            }
+
+            foreach($changes as $uri => $operation) {
+
+                switch($operation) {
+                    case 1:
+                        $result['added'][] = $uri;
+                        break;
+                    case 2:
+                        $result['modified'][] = $uri;
+                        break;
+                    case 3:
+                        $result['deleted'][] = $uri;
+                        break;
+                }
+
+            }
+        } else {
+            // No synctoken supplied, this is the initial sync.
+            $query = "SELECT `uri` FROM `*PREFIX*cards` WHERE `addressbookid` = ?";
+            $stmt = $this->db->prepare($query);
+            $stmt->execute([$addressBookId]);
+
+            $result['added'] = $stmt->fetchAll(\PDO::FETCH_COLUMN);
+        }
+        return $result;
+    }
+
+    /**
+     * Adds a change record to the addressbookchanges table.
+     *
+     * @param mixed $addressBookId
+     * @param string $objectUri
+     * @param int $operation 1 = add, 2 = modify, 3 = delete
+     * @return void
+     */
+    protected function addChange($addressBookId, $objectUri, $operation) {
+        $sql = 'INSERT INTO `*PREFIX*addressbookchanges`(`uri`, `synctoken`, `addressbookid`, `operation`) SELECT ?, `synctoken`, ?, ? FROM `*PREFIX*addressbooks` WHERE `id` = ?';
+        $stmt = $this->db->prepare($sql);
+        $stmt->execute([
+            $objectUri,
+            $addressBookId,
+            $operation,
+            $addressBookId
+        ]);
+        $stmt = $this->db->prepare('UPDATE `*PREFIX*addressbooks` SET `synctoken` = `synctoken` + 1 WHERE `id` = ?');
+        $stmt->execute([
+            $addressBookId
+        ]);
+    }
+
+    private function readBlob($cardData) {
+        if (is_resource($cardData)) {
+            return stream_get_contents($cardData);
+        }
+
+        return $cardData;
+    }
+
+    /**
+     * @param IShareable $shareable
+     * @param string[] $add
+     * @param string[] $remove
+     */
+    public function updateShares(IShareable $shareable, $add, $remove) {
+        $this->sharingBackend->updateShares($shareable, $add, $remove);
+    }
+
+    /**
+     * search contact
+     *
+     * @param int $addressBookId
+     * @param string $pattern which should match within the $searchProperties
+     * @param array $searchProperties defines the properties within the query pattern should match
+     * @param array $options = array() to define the search behavior
+     * 	- 'escape_like_param' - If set to false wildcards _ and % are not escaped, otherwise they are
+     * @return array an array of contacts which are arrays of key-value-pairs
+     */
+    public function search($addressBookId, $pattern, $searchProperties, $options = []) {
+        $query = $this->db->getQueryBuilder();
+        $query2 = $this->db->getQueryBuilder();
+
+        $query2->selectDistinct('cp.cardid')->from($this->dbCardsPropertiesTable, 'cp');
+        $query2->andWhere($query2->expr()->eq('cp.addressbookid', $query->createNamedParameter($addressBookId)));
+        $or = $query2->expr()->orX();
+        foreach ($searchProperties as $property) {
+            $or->add($query2->expr()->eq('cp.name', $query->createNamedParameter($property)));
+        }
+        $query2->andWhere($or);
+
+        // No need for like when the pattern is empty
+        if ('' !== $pattern) {
+            if(\array_key_exists('escape_like_param', $options) && $options['escape_like_param'] === false) {
+                $query2->andWhere($query2->expr()->ilike('cp.value', $query->createNamedParameter($pattern)));
+            } else {
+                $query2->andWhere($query2->expr()->ilike('cp.value', $query->createNamedParameter('%' . $this->db->escapeLikeParameter($pattern) . '%')));
+            }
+        }
+
+        $query->select('c.carddata', 'c.uri')->from($this->dbCardsTable, 'c')
+            ->where($query->expr()->in('c.id', $query->createFunction($query2->getSQL())));
+
+        $result = $query->execute();
+        $cards = $result->fetchAll();
+
+        $result->closeCursor();
+
+        return array_map(function($array) {
+            $array['carddata'] = $this->readBlob($array['carddata']);
+            return $array;
+        }, $cards);
+    }
+
+    /**
+     * @param int $bookId
+     * @param string $name
+     * @return array
+     */
+    public function collectCardProperties($bookId, $name) {
+        $query = $this->db->getQueryBuilder();
+        $result = $query->selectDistinct('value')
+            ->from($this->dbCardsPropertiesTable)
+            ->where($query->expr()->eq('name', $query->createNamedParameter($name)))
+            ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($bookId)))
+            ->execute();
+
+        $all = $result->fetchAll(PDO::FETCH_COLUMN);
+        $result->closeCursor();
+
+        return $all;
+    }
+
+    /**
+     * get URI from a given contact
+     *
+     * @param int $id
+     * @return string
+     */
+    public function getCardUri($id) {
+        $query = $this->db->getQueryBuilder();
+        $query->select('uri')->from($this->dbCardsTable)
+                ->where($query->expr()->eq('id', $query->createParameter('id')))
+                ->setParameter('id', $id);
+
+        $result = $query->execute();
+        $uri = $result->fetch();
+        $result->closeCursor();
+
+        if (!isset($uri['uri'])) {
+            throw new \InvalidArgumentException('Card does not exists: ' . $id);
+        }
+
+        return $uri['uri'];
+    }
+
+    /**
+     * return contact with the given URI
+     *
+     * @param int $addressBookId
+     * @param string $uri
+     * @returns array
+     */
+    public function getContact($addressBookId, $uri) {
+        $result = [];
+        $query = $this->db->getQueryBuilder();
+        $query->select('*')->from($this->dbCardsTable)
+                ->where($query->expr()->eq('uri', $query->createNamedParameter($uri)))
+                ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
+        $queryResult = $query->execute();
+        $contact = $queryResult->fetch();
+        $queryResult->closeCursor();
+
+        if (is_array($contact)) {
+            $result = $contact;
+        }
+
+        return $result;
+    }
+
+    /**
+     * Returns the list of people whom this address book is shared with.
+     *
+     * Every element in this array should have the following properties:
+     *   * href - Often a mailto: address
+     *   * commonName - Optional, for example a first + last name
+     *   * status - See the Sabre\CalDAV\SharingPlugin::STATUS_ constants.
+     *   * readOnly - boolean
+     *   * summary - Optional, a description for the share
+     *
+     * @return array
+     */
+    public function getShares($addressBookId) {
+        return $this->sharingBackend->getShares($addressBookId);
+    }
+
+    /**
+     * update properties table
+     *
+     * @param int $addressBookId
+     * @param string $cardUri
+     * @param string $vCardSerialized
+     */
+    protected function updateProperties($addressBookId, $cardUri, $vCardSerialized) {
+        $cardId = $this->getCardId($addressBookId, $cardUri);
+        $vCard = $this->readCard($vCardSerialized);
+
+        $this->purgeProperties($addressBookId, $cardId);
+
+        $query = $this->db->getQueryBuilder();
+        $query->insert($this->dbCardsPropertiesTable)
+            ->values(
+                [
+                    'addressbookid' => $query->createNamedParameter($addressBookId),
+                    'cardid' => $query->createNamedParameter($cardId),
+                    'name' => $query->createParameter('name'),
+                    'value' => $query->createParameter('value'),
+                    'preferred' => $query->createParameter('preferred')
+                ]
+            );
+
+        foreach ($vCard->children() as $property) {
+            if(!in_array($property->name, self::$indexProperties)) {
+                continue;
+            }
+            $preferred = 0;
+            foreach($property->parameters as $parameter) {
+                if ($parameter->name === 'TYPE' && strtoupper($parameter->getValue()) === 'PREF') {
+                    $preferred = 1;
+                    break;
+                }
+            }
+            $query->setParameter('name', $property->name);
+            $query->setParameter('value', mb_substr($property->getValue(), 0, 254));
+            $query->setParameter('preferred', $preferred);
+            $query->execute();
+        }
+    }
+
+    /**
+     * read vCard data into a vCard object
+     *
+     * @param string $cardData
+     * @return VCard
+     */
+    protected function readCard($cardData) {
+        return  Reader::read($cardData);
+    }
+
+    /**
+     * delete all properties from a given card
+     *
+     * @param int $addressBookId
+     * @param int $cardId
+     */
+    protected function purgeProperties($addressBookId, $cardId) {
+        $query = $this->db->getQueryBuilder();
+        $query->delete($this->dbCardsPropertiesTable)
+            ->where($query->expr()->eq('cardid', $query->createNamedParameter($cardId)))
+            ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
+        $query->execute();
+    }
+
+    /**
+     * get ID from a given contact
+     *
+     * @param int $addressBookId
+     * @param string $uri
+     * @return int
+     */
+    protected function getCardId($addressBookId, $uri) {
+        $query = $this->db->getQueryBuilder();
+        $query->select('id')->from($this->dbCardsTable)
+            ->where($query->expr()->eq('uri', $query->createNamedParameter($uri)))
+            ->andWhere($query->expr()->eq('addressbookid', $query->createNamedParameter($addressBookId)));
+
+        $result = $query->execute();
+        $cardIds = $result->fetch();
+        $result->closeCursor();
+
+        if (!isset($cardIds['id'])) {
+            throw new \InvalidArgumentException('Card does not exists: ' . $uri);
+        }
+
+        return (int)$cardIds['id'];
+    }
+
+    /**
+     * For shared address books the sharee is set in the ACL of the address book
+     * @param $addressBookId
+     * @param $acl
+     * @return array
+     */
+    public function applyShareAcl($addressBookId, $acl) {
+        return $this->sharingBackend->applyShareAcl($addressBookId, $acl);
+    }
+
+    private function convertPrincipal($principalUri, $toV2) {
+        if ($this->principalBackend->getPrincipalPrefix() === 'principals') {
+            list(, $name) = \Sabre\Uri\split($principalUri);
+            if ($toV2 === true) {
+                return "principals/users/$name";
+            }
+            return "principals/$name";
+        }
+        return $principalUri;
+    }
+
+    private function addOwnerPrincipal(&$addressbookInfo) {
+        $ownerPrincipalKey = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_OWNCLOUD . '}owner-principal';
+        $displaynameKey = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_NEXTCLOUD . '}owner-displayname';
+        if (isset($addressbookInfo[$ownerPrincipalKey])) {
+            $uri = $addressbookInfo[$ownerPrincipalKey];
+        } else {
+            $uri = $addressbookInfo['principaluri'];
+        }
+
+        $principalInformation = $this->principalBackend->getPrincipalByPath($uri);
+        if (isset($principalInformation['{DAV:}displayname'])) {
+            $addressbookInfo[$displaynameKey] = $principalInformation['{DAV:}displayname'];
+        }
+    }
+
+    /**
+     * Extract UID from vcard
+     *
+     * @param string $cardData the vcard raw data
+     * @return string the uid
+     * @throws BadRequest if no UID is available
+     */
+    private function getUID($cardData) {
+        if ($cardData != '') {
+            $vCard = Reader::read($cardData);
+            if ($vCard->UID) {
+                $uid = $vCard->UID->getValue();
+                return $uid;
+            }
+            // should already be handled, but just in case
+            throw new BadRequest('vCards on CardDAV servers MUST have a UID property');
+        }
+        // should already be handled, but just in case
+        throw new BadRequest('vCard can not be empty');
+    }
 }

apps/theming/appinfo/routes.php

Indentation +54 added lines, -54 removed lines

@@ -28,59 +28,59 @@
  */
 
 return ['routes' => [
-	[
-		'name' => 'Theming#updateStylesheet',
-		'url' => '/ajax/updateStylesheet',
-		'verb' => 'POST'
-	],
-	[
-		'name' => 'Theming#undo',
-		'url' => '/ajax/undoChanges',
-		'verb' => 'POST'
-	],
-	[
-		'name' => 'Theming#uploadImage',
-		'url' => '/ajax/uploadImage',
-		'verb' => 'POST'
-	],
-	[
-		'name' => 'Theming#getStylesheet',
-		'url' => '/styles',
-		'verb' => 'GET',
-	],
-	[
-		'name' => 'Theming#getImage',
-		'url' => '/image/{key}',
-		'verb' => 'GET',
-	],
-	[
-		'name' => 'Theming#getJavascript',
-		'url' => '/js/theming',
-		'verb' => 'GET',
-	],
-	[
-		'name' => 'Theming#getManifest',
-		'url' => '/manifest/{app}',
-		'verb' => 'GET',
-		'defaults' => ['app' => 'core']
-	],
-	[
-		'name'	=> 'Icon#getFavicon',
-		'url' => '/favicon/{app}',
-		'verb' => 'GET',
-		'defaults' => ['app' => 'core'],
-	],
-	[
-		'name'	=> 'Icon#getTouchIcon',
-		'url' => '/icon/{app}',
-		'verb' => 'GET',
-		'defaults' => ['app' => 'core'],
-	],
-	[
-		'name'	=> 'Icon#getThemedIcon',
-		'url' => '/img/{app}/{image}',
-		'verb' => 'GET',
-		'requirements' => ['image' => '.+']
-	],
+    [
+        'name' => 'Theming#updateStylesheet',
+        'url' => '/ajax/updateStylesheet',
+        'verb' => 'POST'
+    ],
+    [
+        'name' => 'Theming#undo',
+        'url' => '/ajax/undoChanges',
+        'verb' => 'POST'
+    ],
+    [
+        'name' => 'Theming#uploadImage',
+        'url' => '/ajax/uploadImage',
+        'verb' => 'POST'
+    ],
+    [
+        'name' => 'Theming#getStylesheet',
+        'url' => '/styles',
+        'verb' => 'GET',
+    ],
+    [
+        'name' => 'Theming#getImage',
+        'url' => '/image/{key}',
+        'verb' => 'GET',
+    ],
+    [
+        'name' => 'Theming#getJavascript',
+        'url' => '/js/theming',
+        'verb' => 'GET',
+    ],
+    [
+        'name' => 'Theming#getManifest',
+        'url' => '/manifest/{app}',
+        'verb' => 'GET',
+        'defaults' => ['app' => 'core']
+    ],
+    [
+        'name'	=> 'Icon#getFavicon',
+        'url' => '/favicon/{app}',
+        'verb' => 'GET',
+        'defaults' => ['app' => 'core'],
+    ],
+    [
+        'name'	=> 'Icon#getTouchIcon',
+        'url' => '/icon/{app}',
+        'verb' => 'GET',
+        'defaults' => ['app' => 'core'],
+    ],
+    [
+        'name'	=> 'Icon#getThemedIcon',
+        'url' => '/img/{app}/{image}',
+        'verb' => 'GET',
+        'requirements' => ['image' => '.+']
+    ],
 ]];
 

apps/theming/lib/Util.php

Indentation +210 added lines, -210 removed lines

@@ -38,215 +38,215 @@
 
 class Util {
 
-	/** @var IConfig */
-	private $config;
-
-	/** @var IAppManager */
-	private $appManager;
-
-	/** @var IAppData */
-	private $appData;
-
-	/**
-	 * Util constructor.
-	 *
-	 * @param IConfig $config
-	 * @param IAppManager $appManager
-	 * @param IAppData $appData
-	 */
-	public function __construct(IConfig $config, IAppManager $appManager, IAppData $appData) {
-		$this->config = $config;
-		$this->appManager = $appManager;
-		$this->appData = $appData;
-	}
-
-	/**
-	 * @param string $color rgb color value
-	 * @return bool
-	 */
-	public function invertTextColor($color) {
-		$l = $this->calculateLuma($color);
-		if($l>0.6) {
-			return true;
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * get color for on-page elements:
-	 * theme color by default, grey if theme color is to bright
-	 * @param $color
-	 * @return string
-	 */
-	public function elementColor($color) {
-		$l = $this->calculateLuminance($color);
-		if($l>0.8) {
-			return '#aaaaaa';
-		}
-		return $color;
-	}
-
-	/**
-	 * @param string $color rgb color value
-	 * @return float
-	 */
-	public function calculateLuminance($color) {
-		list($red, $green, $blue) = $this->hexToRGB($color);
-		$compiler = new Compiler();
-		$hsl = $compiler->toHSL($red, $green, $blue);
-		return $hsl[3]/100;
-	}
-
-	/**
-	 * @param string $color rgb color value
-	 * @return float
-	 */
-	public function calculateLuma($color) {
-		list($red, $green, $blue) = $this->hexToRGB($color);
-		return (0.2126 * $red  + 0.7152 * $green + 0.0722 * $blue) / 255;
-	}
-
-	/**
-	 * @param string $color rgb color value
-	 * @return int[]
-	 */
-	public function hexToRGB($color) {
-		$hex = preg_replace("/[^0-9A-Fa-f]/", '', $color);
-		if (strlen($hex) === 3) {
-			$hex = $hex[0] . $hex[0] . $hex[1] . $hex[1] . $hex[2] . $hex[2];
-		}
-		if (strlen($hex) !== 6) {
-			return 0;
-		}
-		return [
-			hexdec(substr($hex, 0, 2)),
-			hexdec(substr($hex, 2, 2)),
-			hexdec(substr($hex, 4, 2))
-		];
-	}
-
-	/**
-	 * @param $color
-	 * @return string base64 encoded radio button svg
-	 */
-	public function generateRadioButton($color) {
-		$radioButtonIcon = '<svg xmlns="http://www.w3.org/2000/svg" height="16" width="16">' .
-			'<path d="M8 1a7 7 0 0 0-7 7 7 7 0 0 0 7 7 7 7 0 0 0 7-7 7 7 0 0 0-7-7zm0 1a6 6 0 0 1 6 6 6 6 0 0 1-6 6 6 6 0 0 1-6-6 6 6 0 0 1 6-6zm0 2a4 4 0 1 0 0 8 4 4 0 0 0 0-8z" fill="'.$color.'"/></svg>';
-		return base64_encode($radioButtonIcon);
-	}
-
-
-	/**
-	 * @param $app string app name
-	 * @return string|ISimpleFile path to app icon / file of logo
-	 */
-	public function getAppIcon($app) {
-		$app = str_replace(['\0', '/', '\\', '..'], '', $app);
-		try {
-			$appPath = $this->appManager->getAppPath($app);
-			$icon = $appPath . '/img/' . $app . '.svg';
-			if (file_exists($icon)) {
-				return $icon;
-			}
-			$icon = $appPath . '/img/app.svg';
-			if (file_exists($icon)) {
-				return $icon;
-			}
-		} catch (AppPathNotFoundException $e) {}
-
-		if ($this->config->getAppValue('theming', 'logoMime', '') !== '') {
-			$logoFile = null;
-			try {
-				$folder = $this->appData->getFolder('images');
-				if ($folder !== null) {
-					return $folder->getFile('logo');
-				}
-			} catch (NotFoundException $e) {}
-		}
-		return \OC::$SERVERROOT . '/core/img/logo/logo.svg';
-	}
-
-	/**
-	 * @param $app string app name
-	 * @param $image string relative path to image in app folder
-	 * @return string|false absolute path to image
-	 */
-	public function getAppImage($app, $image) {
-		$app = str_replace(['\0', '/', '\\', '..'], '', $app);
-		$image = str_replace(['\0', '\\', '..'], '', $image);
-		if ($app === "core") {
-			$icon = \OC::$SERVERROOT . '/core/img/' . $image;
-			if (file_exists($icon)) {
-				return $icon;
-			}
-		}
-
-		try {
-			$appPath = $this->appManager->getAppPath($app);
-		} catch (AppPathNotFoundException $e) {
-			return false;
-		}
-
-		$icon = $appPath . '/img/' . $image;
-		if (file_exists($icon)) {
-			return $icon;
-		}
-		$icon = $appPath . '/img/' . $image . '.svg';
-		if (file_exists($icon)) {
-			return $icon;
-		}
-		$icon = $appPath . '/img/' . $image . '.png';
-		if (file_exists($icon)) {
-			return $icon;
-		}
-		$icon = $appPath . '/img/' . $image . '.gif';
-		if (file_exists($icon)) {
-			return $icon;
-		}
-		$icon = $appPath . '/img/' . $image . '.jpg';
-		if (file_exists($icon)) {
-			return $icon;
-		}
-
-		return false;
-	}
-
-	/**
-	 * replace default color with a custom one
-	 *
-	 * @param $svg string content of a svg file
-	 * @param $color string color to match
-	 * @return string
-	 */
-	public function colorizeSvg($svg, $color) {
-		$svg = preg_replace('/#0082c9/i', $color, $svg);
-		return $svg;
-	}
-
-	/**
-	 * Check if a custom theme is set in the server configuration
-	 *
-	 * @return bool
-	 */
-	public function isAlreadyThemed() {
-		$theme = $this->config->getSystemValue('theme', '');
-		if ($theme !== '') {
-			return true;
-		}
-		return false;
-	}
-
-	public function isBackgroundThemed() {
-		$backgroundLogo = $this->config->getAppValue('theming', 'backgroundMime',false);
-
-		$backgroundExists = true;
-		try {
-			$this->appData->getFolder('images')->getFile('background');
-		} catch (\Exception $e) {
-			$backgroundExists = false;
-		}
-		return $backgroundLogo && $backgroundLogo !== 'backgroundColor' && $backgroundExists;
-	}
+    /** @var IConfig */
+    private $config;
+
+    /** @var IAppManager */
+    private $appManager;
+
+    /** @var IAppData */
+    private $appData;
+
+    /**
+     * Util constructor.
+     *
+     * @param IConfig $config
+     * @param IAppManager $appManager
+     * @param IAppData $appData
+     */
+    public function __construct(IConfig $config, IAppManager $appManager, IAppData $appData) {
+        $this->config = $config;
+        $this->appManager = $appManager;
+        $this->appData = $appData;
+    }
+
+    /**
+     * @param string $color rgb color value
+     * @return bool
+     */
+    public function invertTextColor($color) {
+        $l = $this->calculateLuma($color);
+        if($l>0.6) {
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * get color for on-page elements:
+     * theme color by default, grey if theme color is to bright
+     * @param $color
+     * @return string
+     */
+    public function elementColor($color) {
+        $l = $this->calculateLuminance($color);
+        if($l>0.8) {
+            return '#aaaaaa';
+        }
+        return $color;
+    }
+
+    /**
+     * @param string $color rgb color value
+     * @return float
+     */
+    public function calculateLuminance($color) {
+        list($red, $green, $blue) = $this->hexToRGB($color);
+        $compiler = new Compiler();
+        $hsl = $compiler->toHSL($red, $green, $blue);
+        return $hsl[3]/100;
+    }
+
+    /**
+     * @param string $color rgb color value
+     * @return float
+     */
+    public function calculateLuma($color) {
+        list($red, $green, $blue) = $this->hexToRGB($color);
+        return (0.2126 * $red  + 0.7152 * $green + 0.0722 * $blue) / 255;
+    }
+
+    /**
+     * @param string $color rgb color value
+     * @return int[]
+     */
+    public function hexToRGB($color) {
+        $hex = preg_replace("/[^0-9A-Fa-f]/", '', $color);
+        if (strlen($hex) === 3) {
+            $hex = $hex[0] . $hex[0] . $hex[1] . $hex[1] . $hex[2] . $hex[2];
+        }
+        if (strlen($hex) !== 6) {
+            return 0;
+        }
+        return [
+            hexdec(substr($hex, 0, 2)),
+            hexdec(substr($hex, 2, 2)),
+            hexdec(substr($hex, 4, 2))
+        ];
+    }
+
+    /**
+     * @param $color
+     * @return string base64 encoded radio button svg
+     */
+    public function generateRadioButton($color) {
+        $radioButtonIcon = '<svg xmlns="http://www.w3.org/2000/svg" height="16" width="16">' .
+            '<path d="M8 1a7 7 0 0 0-7 7 7 7 0 0 0 7 7 7 7 0 0 0 7-7 7 7 0 0 0-7-7zm0 1a6 6 0 0 1 6 6 6 6 0 0 1-6 6 6 6 0 0 1-6-6 6 6 0 0 1 6-6zm0 2a4 4 0 1 0 0 8 4 4 0 0 0 0-8z" fill="'.$color.'"/></svg>';
+        return base64_encode($radioButtonIcon);
+    }
+
+
+    /**
+     * @param $app string app name
+     * @return string|ISimpleFile path to app icon / file of logo
+     */
+    public function getAppIcon($app) {
+        $app = str_replace(['\0', '/', '\\', '..'], '', $app);
+        try {
+            $appPath = $this->appManager->getAppPath($app);
+            $icon = $appPath . '/img/' . $app . '.svg';
+            if (file_exists($icon)) {
+                return $icon;
+            }
+            $icon = $appPath . '/img/app.svg';
+            if (file_exists($icon)) {
+                return $icon;
+            }
+        } catch (AppPathNotFoundException $e) {}
+
+        if ($this->config->getAppValue('theming', 'logoMime', '') !== '') {
+            $logoFile = null;
+            try {
+                $folder = $this->appData->getFolder('images');
+                if ($folder !== null) {
+                    return $folder->getFile('logo');
+                }
+            } catch (NotFoundException $e) {}
+        }
+        return \OC::$SERVERROOT . '/core/img/logo/logo.svg';
+    }
+
+    /**
+     * @param $app string app name
+     * @param $image string relative path to image in app folder
+     * @return string|false absolute path to image
+     */
+    public function getAppImage($app, $image) {
+        $app = str_replace(['\0', '/', '\\', '..'], '', $app);
+        $image = str_replace(['\0', '\\', '..'], '', $image);
+        if ($app === "core") {
+            $icon = \OC::$SERVERROOT . '/core/img/' . $image;
+            if (file_exists($icon)) {
+                return $icon;
+            }
+        }
+
+        try {
+            $appPath = $this->appManager->getAppPath($app);
+        } catch (AppPathNotFoundException $e) {
+            return false;
+        }
+
+        $icon = $appPath . '/img/' . $image;
+        if (file_exists($icon)) {
+            return $icon;
+        }
+        $icon = $appPath . '/img/' . $image . '.svg';
+        if (file_exists($icon)) {
+            return $icon;
+        }
+        $icon = $appPath . '/img/' . $image . '.png';
+        if (file_exists($icon)) {
+            return $icon;
+        }
+        $icon = $appPath . '/img/' . $image . '.gif';
+        if (file_exists($icon)) {
+            return $icon;
+        }
+        $icon = $appPath . '/img/' . $image . '.jpg';
+        if (file_exists($icon)) {
+            return $icon;
+        }
+
+        return false;
+    }
+
+    /**
+     * replace default color with a custom one
+     *
+     * @param $svg string content of a svg file
+     * @param $color string color to match
+     * @return string
+     */
+    public function colorizeSvg($svg, $color) {
+        $svg = preg_replace('/#0082c9/i', $color, $svg);
+        return $svg;
+    }
+
+    /**
+     * Check if a custom theme is set in the server configuration
+     *
+     * @return bool
+     */
+    public function isAlreadyThemed() {
+        $theme = $this->config->getSystemValue('theme', '');
+        if ($theme !== '') {
+            return true;
+        }
+        return false;
+    }
+
+    public function isBackgroundThemed() {
+        $backgroundLogo = $this->config->getAppValue('theming', 'backgroundMime',false);
+
+        $backgroundExists = true;
+        try {
+            $this->appData->getFolder('images')->getFile('background');
+        } catch (\Exception $e) {
+            $backgroundExists = false;
+        }
+        return $backgroundLogo && $backgroundLogo !== 'backgroundColor' && $backgroundExists;
+    }
 
 }

Spacing +16 added lines, -16 removed lines

@@ -66,7 +66,7 @@ 
 	 */
 	public function invertTextColor($color) {
 		$l = $this->calculateLuma($color);
-		if($l>0.6) {
+		if ($l > 0.6) {
 			return true;
 		} else {
 			return false;
@@ -81,7 +81,7 @@ 
 	 */
 	public function elementColor($color) {
 		$l = $this->calculateLuminance($color);
-		if($l>0.8) {
+		if ($l > 0.8) {
 			return '#aaaaaa';
 		}
 		return $color;
@@ -95,7 +95,7 @@ 
 		list($red, $green, $blue) = $this->hexToRGB($color);
 		$compiler = new Compiler();
 		$hsl = $compiler->toHSL($red, $green, $blue);
-		return $hsl[3]/100;
+		return $hsl[3] / 100;
 	}
 
 	/**
@@ -104,7 +104,7 @@ 
 	 */
 	public function calculateLuma($color) {
 		list($red, $green, $blue) = $this->hexToRGB($color);
-		return (0.2126 * $red  + 0.7152 * $green + 0.0722 * $blue) / 255;
+		return (0.2126 * $red + 0.7152 * $green + 0.0722 * $blue) / 255;
 	}
 
 	/**
@@ -114,7 +114,7 @@ 
 	public function hexToRGB($color) {
 		$hex = preg_replace("/[^0-9A-Fa-f]/", '', $color);
 		if (strlen($hex) === 3) {
-			$hex = $hex[0] . $hex[0] . $hex[1] . $hex[1] . $hex[2] . $hex[2];
+			$hex = $hex[0].$hex[0].$hex[1].$hex[1].$hex[2].$hex[2];
 		}
 		if (strlen($hex) !== 6) {
 			return 0;
@@ -131,7 +131,7 @@ 
 	 * @return string base64 encoded radio button svg
 	 */
 	public function generateRadioButton($color) {
-		$radioButtonIcon = '<svg xmlns="http://www.w3.org/2000/svg" height="16" width="16">' .
+		$radioButtonIcon = '<svg xmlns="http://www.w3.org/2000/svg" height="16" width="16">'.
 			'<path d="M8 1a7 7 0 0 0-7 7 7 7 0 0 0 7 7 7 7 0 0 0 7-7 7 7 0 0 0-7-7zm0 1a6 6 0 0 1 6 6 6 6 0 0 1-6 6 6 6 0 0 1-6-6 6 6 0 0 1 6-6zm0 2a4 4 0 1 0 0 8 4 4 0 0 0 0-8z" fill="'.$color.'"/></svg>';
 		return base64_encode($radioButtonIcon);
 	}
@@ -145,11 +145,11 @@ 
 		$app = str_replace(['\0', '/', '\\', '..'], '', $app);
 		try {
 			$appPath = $this->appManager->getAppPath($app);
-			$icon = $appPath . '/img/' . $app . '.svg';
+			$icon = $appPath.'/img/'.$app.'.svg';
 			if (file_exists($icon)) {
 				return $icon;
 			}
-			$icon = $appPath . '/img/app.svg';
+			$icon = $appPath.'/img/app.svg';
 			if (file_exists($icon)) {
 				return $icon;
 			}
@@ -164,7 +164,7 @@ 
 				}
 			} catch (NotFoundException $e) {}
 		}
-		return \OC::$SERVERROOT . '/core/img/logo/logo.svg';
+		return \OC::$SERVERROOT.'/core/img/logo/logo.svg';
 	}
 
 	/**
@@ -176,7 +176,7 @@ 
 		$app = str_replace(['\0', '/', '\\', '..'], '', $app);
 		$image = str_replace(['\0', '\\', '..'], '', $image);
 		if ($app === "core") {
-			$icon = \OC::$SERVERROOT . '/core/img/' . $image;
+			$icon = \OC::$SERVERROOT.'/core/img/'.$image;
 			if (file_exists($icon)) {
 				return $icon;
 			}
@@ -188,23 +188,23 @@ 
 			return false;
 		}
 
-		$icon = $appPath . '/img/' . $image;
+		$icon = $appPath.'/img/'.$image;
 		if (file_exists($icon)) {
 			return $icon;
 		}
-		$icon = $appPath . '/img/' . $image . '.svg';
+		$icon = $appPath.'/img/'.$image.'.svg';
 		if (file_exists($icon)) {
 			return $icon;
 		}
-		$icon = $appPath . '/img/' . $image . '.png';
+		$icon = $appPath.'/img/'.$image.'.png';
 		if (file_exists($icon)) {
 			return $icon;
 		}
-		$icon = $appPath . '/img/' . $image . '.gif';
+		$icon = $appPath.'/img/'.$image.'.gif';
 		if (file_exists($icon)) {
 			return $icon;
 		}
-		$icon = $appPath . '/img/' . $image . '.jpg';
+		$icon = $appPath.'/img/'.$image.'.jpg';
 		if (file_exists($icon)) {
 			return $icon;
 		}
@@ -238,7 +238,7 @@ 
 	}
 
 	public function isBackgroundThemed() {
-		$backgroundLogo = $this->config->getAppValue('theming', 'backgroundMime',false);
+		$backgroundLogo = $this->config->getAppValue('theming', 'backgroundMime', false);
 
 		$backgroundExists = true;
 		try {

apps/encryption/templates/altmail.php

Indentation +2 added lines, -2 removed lines

@@ -4,8 +4,8 @@
 
 print_unescaped($l->t("Hey there,\n\nthe admin enabled server-side-encryption. Your files were encrypted using the password '%s'.\n\nPlease login to the web interface, go to the section 'basic encryption module' of your personal settings and update your encryption password by entering this password into the 'old log-in password' field and your current login-password.\n\n", [$_['password']]));
 if ( isset($_['expiration']) ) {
-	print_unescaped($l->t("The share will expire on %s.", [$_['expiration']]));
-	print_unescaped("\n\n");
+    print_unescaped($l->t("The share will expire on %s.", [$_['expiration']]));
+    print_unescaped("\n\n");
 }
 // TRANSLATORS term at the end of a mail
 p($l->t("Cheers!"));

Spacing +2 added lines, -2 removed lines

@@ -3,7 +3,7 @@ 
 /** @var array $_ */
 
 print_unescaped($l->t("Hey there,\n\nthe admin enabled server-side-encryption. Your files were encrypted using the password '%s'.\n\nPlease login to the web interface, go to the section 'basic encryption module' of your personal settings and update your encryption password by entering this password into the 'old log-in password' field and your current login-password.\n\n", [$_['password']]));
-if ( isset($_['expiration']) ) {
+if (isset($_['expiration'])) {
 	print_unescaped($l->t("The share will expire on %s.", [$_['expiration']]));
 	print_unescaped("\n\n");
 }
@@ -12,5 +12,5 @@ 
 ?>
 
 	--
-<?php p($theme->getName() . ' - ' . $theme->getSlogan()); ?>
+<?php p($theme->getName().' - '.$theme->getSlogan()); ?>
 <?php print_unescaped("\n".$theme->getBaseUrl());

apps/encryption/lib/Crypto/Encryption.php

Indentation +553 added lines, -553 removed lines

@@ -46,557 +46,557 @@
 
 class Encryption implements IEncryptionModule {
 
-	const ID = 'OC_DEFAULT_MODULE';
-	const DISPLAY_NAME = 'Default encryption module';
-
-	/**
-	 * @var Crypt
-	 */
-	private $crypt;
-
-	/** @var string */
-	private $cipher;
-
-	/** @var string */
-	private $path;
-
-	/** @var string */
-	private $user;
-
-	/** @var  array */
-	private $owner;
-
-	/** @var string */
-	private $fileKey;
-
-	/** @var string */
-	private $writeCache;
-
-	/** @var KeyManager */
-	private $keyManager;
-
-	/** @var array */
-	private $accessList;
-
-	/** @var boolean */
-	private $isWriteOperation;
-
-	/** @var Util */
-	private $util;
-
-	/** @var  Session */
-	private $session;
-
-	/** @var  ILogger */
-	private $logger;
-
-	/** @var IL10N */
-	private $l;
-
-	/** @var EncryptAll */
-	private $encryptAll;
-
-	/** @var  bool */
-	private $useMasterPassword;
-
-	/** @var DecryptAll  */
-	private $decryptAll;
-
-	/** @var int unencrypted block size if block contains signature */
-	private $unencryptedBlockSizeSigned = 6072;
-
-	/** @var int unencrypted block size */
-	private $unencryptedBlockSize = 6126;
-
-	/** @var int Current version of the file */
-	private $version = 0;
-
-	/** @var array remember encryption signature version */
-	private static $rememberVersion = [];
-
-
-	/**
-	 *
-	 * @param Crypt $crypt
-	 * @param KeyManager $keyManager
-	 * @param Util $util
-	 * @param Session $session
-	 * @param EncryptAll $encryptAll
-	 * @param DecryptAll $decryptAll
-	 * @param ILogger $logger
-	 * @param IL10N $il10n
-	 */
-	public function __construct(Crypt $crypt,
-								KeyManager $keyManager,
-								Util $util,
-								Session $session,
-								EncryptAll $encryptAll,
-								DecryptAll $decryptAll,
-								ILogger $logger,
-								IL10N $il10n) {
-		$this->crypt = $crypt;
-		$this->keyManager = $keyManager;
-		$this->util = $util;
-		$this->session = $session;
-		$this->encryptAll = $encryptAll;
-		$this->decryptAll = $decryptAll;
-		$this->logger = $logger;
-		$this->l = $il10n;
-		$this->owner = [];
-		$this->useMasterPassword = $util->isMasterKeyEnabled();
-	}
-
-	/**
-	 * @return string defining the technical unique id
-	 */
-	public function getId() {
-		return self::ID;
-	}
-
-	/**
-	 * In comparison to getKey() this function returns a human readable (maybe translated) name
-	 *
-	 * @return string
-	 */
-	public function getDisplayName() {
-		return self::DISPLAY_NAME;
-	}
-
-	/**
-	 * start receiving chunks from a file. This is the place where you can
-	 * perform some initial step before starting encrypting/decrypting the
-	 * chunks
-	 *
-	 * @param string $path to the file
-	 * @param string $user who read/write the file
-	 * @param string $mode php stream open mode
-	 * @param array $header contains the header data read from the file
-	 * @param array $accessList who has access to the file contains the key 'users' and 'public'
-	 *
-	 * @return array $header contain data as key-value pairs which should be
-	 *                       written to the header, in case of a write operation
-	 *                       or if no additional data is needed return a empty array
-	 */
-	public function begin($path, $user, $mode, array $header, array $accessList) {
-		$this->path = $this->getPathToRealFile($path);
-		$this->accessList = $accessList;
-		$this->user = $user;
-		$this->isWriteOperation = false;
-		$this->writeCache = '';
-
-		if($this->session->isReady() === false) {
-			// if the master key is enabled we can initialize encryption
-			// with a empty password and user name
-			if ($this->util->isMasterKeyEnabled()) {
-				$this->keyManager->init('', '');
-			}
-		}
-
-		if ($this->session->decryptAllModeActivated()) {
-			$encryptedFileKey = $this->keyManager->getEncryptedFileKey($this->path);
-			$shareKey = $this->keyManager->getShareKey($this->path, $this->session->getDecryptAllUid());
-			$this->fileKey = $this->crypt->multiKeyDecrypt($encryptedFileKey,
-				$shareKey,
-				$this->session->getDecryptAllKey());
-		} else {
-			$this->fileKey = $this->keyManager->getFileKey($this->path, $this->user);
-		}
-
-		// always use the version from the original file, also part files
-		// need to have a correct version number if they get moved over to the
-		// final location
-		$this->version = (int)$this->keyManager->getVersion($this->stripPartFileExtension($path), new View());
-
-		if (
-			$mode === 'w'
-			|| $mode === 'w+'
-			|| $mode === 'wb'
-			|| $mode === 'wb+'
-		) {
-			$this->isWriteOperation = true;
-			if (empty($this->fileKey)) {
-				$this->fileKey = $this->crypt->generateFileKey();
-			}
-		} else {
-			// if we read a part file we need to increase the version by 1
-			// because the version number was also increased by writing
-			// the part file
-			if(Scanner::isPartialFile($path)) {
-				$this->version = $this->version + 1;
-			}
-		}
-
-		if ($this->isWriteOperation) {
-			$this->cipher = $this->crypt->getCipher();
-		} elseif (isset($header['cipher'])) {
-			$this->cipher = $header['cipher'];
-		} else {
-			// if we read a file without a header we fall-back to the legacy cipher
-			// which was used in <=oC6
-			$this->cipher = $this->crypt->getLegacyCipher();
-		}
-
-		return ['cipher' => $this->cipher, 'signed' => 'true'];
-	}
-
-	/**
-	 * last chunk received. This is the place where you can perform some final
-	 * operation and return some remaining data if something is left in your
-	 * buffer.
-	 *
-	 * @param string $path to the file
-	 * @param int $position
-	 * @return string remained data which should be written to the file in case
-	 *                of a write operation
-	 * @throws PublicKeyMissingException
-	 * @throws \Exception
-	 * @throws \OCA\Encryption\Exceptions\MultiKeyEncryptException
-	 */
-	public function end($path, $position = 0) {
-		$result = '';
-		if ($this->isWriteOperation) {
-			// in case of a part file we remember the new signature versions
-			// the version will be set later on update.
-			// This way we make sure that other apps listening to the pre-hooks
-			// still get the old version which should be the correct value for them
-			if (Scanner::isPartialFile($path)) {
-				self::$rememberVersion[$this->stripPartFileExtension($path)] = $this->version + 1;
-			}
-			if (!empty($this->writeCache)) {
-				$result = $this->crypt->symmetricEncryptFileContent($this->writeCache, $this->fileKey, $this->version + 1, $position);
-				$this->writeCache = '';
-			}
-			$publicKeys = [];
-			if ($this->useMasterPassword === true) {
-				$publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey();
-			} else {
-				foreach ($this->accessList['users'] as $uid) {
-					try {
-						$publicKeys[$uid] = $this->keyManager->getPublicKey($uid);
-					} catch (PublicKeyMissingException $e) {
-						$this->logger->warning(
-							'no public key found for user "{uid}", user will not be able to read the file',
-							['app' => 'encryption', 'uid' => $uid]
-						);
-						// if the public key of the owner is missing we should fail
-						if ($uid === $this->user) {
-							throw $e;
-						}
-					}
-				}
-			}
-
-			$publicKeys = $this->keyManager->addSystemKeys($this->accessList, $publicKeys, $this->getOwner($path));
-			$encryptedKeyfiles = $this->crypt->multiKeyEncrypt($this->fileKey, $publicKeys);
-			$this->keyManager->setAllFileKeys($this->path, $encryptedKeyfiles);
-		}
-		return $result;
-	}
-
-
-
-	/**
-	 * encrypt data
-	 *
-	 * @param string $data you want to encrypt
-	 * @param int $position
-	 * @return string encrypted data
-	 */
-	public function encrypt($data, $position = 0) {
-		// If extra data is left over from the last round, make sure it
-		// is integrated into the next block
-		if ($this->writeCache) {
-
-			// Concat writeCache to start of $data
-			$data = $this->writeCache . $data;
-
-			// Clear the write cache, ready for reuse - it has been
-			// flushed and its old contents processed
-			$this->writeCache = '';
-
-		}
-
-		$encrypted = '';
-		// While there still remains some data to be processed & written
-		while (strlen($data) > 0) {
-
-			// Remaining length for this iteration, not of the
-			// entire file (may be greater than 8192 bytes)
-			$remainingLength = strlen($data);
-
-			// If data remaining to be written is less than the
-			// size of 1 6126 byte block
-			if ($remainingLength < $this->unencryptedBlockSizeSigned) {
-
-				// Set writeCache to contents of $data
-				// The writeCache will be carried over to the
-				// next write round, and added to the start of
-				// $data to ensure that written blocks are
-				// always the correct length. If there is still
-				// data in writeCache after the writing round
-				// has finished, then the data will be written
-				// to disk by $this->flush().
-				$this->writeCache = $data;
-
-				// Clear $data ready for next round
-				$data = '';
-
-			} else {
-
-				// Read the chunk from the start of $data
-				$chunk = substr($data, 0, $this->unencryptedBlockSizeSigned);
-
-				$encrypted .= $this->crypt->symmetricEncryptFileContent($chunk, $this->fileKey, $this->version + 1, $position);
-
-				// Remove the chunk we just processed from
-				// $data, leaving only unprocessed data in $data
-				// var, for handling on the next round
-				$data = substr($data, $this->unencryptedBlockSizeSigned);
-
-			}
-
-		}
-
-		return $encrypted;
-	}
-
-	/**
-	 * decrypt data
-	 *
-	 * @param string $data you want to decrypt
-	 * @param int $position
-	 * @return string decrypted data
-	 * @throws DecryptionFailedException
-	 */
-	public function decrypt($data, $position = 0) {
-		if (empty($this->fileKey)) {
-			$msg = 'Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.';
-			$hint = $this->l->t('Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.');
-			$this->logger->error($msg);
-
-			throw new DecryptionFailedException($msg, $hint);
-		}
-
-		return $this->crypt->symmetricDecryptFileContent($data, $this->fileKey, $this->cipher, $this->version, $position);
-	}
-
-	/**
-	 * update encrypted file, e.g. give additional users access to the file
-	 *
-	 * @param string $path path to the file which should be updated
-	 * @param string $uid of the user who performs the operation
-	 * @param array $accessList who has access to the file contains the key 'users' and 'public'
-	 * @return boolean
-	 */
-	public function update($path, $uid, array $accessList) {
-
-		if (empty($accessList)) {
-			if (isset(self::$rememberVersion[$path])) {
-				$this->keyManager->setVersion($path, self::$rememberVersion[$path], new View());
-				unset(self::$rememberVersion[$path]);
-			}
-			return;
-		}
-
-		$fileKey = $this->keyManager->getFileKey($path, $uid);
-
-		if (!empty($fileKey)) {
-
-			$publicKeys = [];
-			if ($this->useMasterPassword === true) {
-				$publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey();
-			} else {
-				foreach ($accessList['users'] as $user) {
-					try {
-						$publicKeys[$user] = $this->keyManager->getPublicKey($user);
-					} catch (PublicKeyMissingException $e) {
-						$this->logger->warning('Could not encrypt file for ' . $user . ': ' . $e->getMessage());
-					}
-				}
-			}
-
-			$publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $this->getOwner($path));
-
-			$encryptedFileKey = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys);
-
-			$this->keyManager->deleteAllFileKeys($path);
-
-			$this->keyManager->setAllFileKeys($path, $encryptedFileKey);
-
-		} else {
-			$this->logger->debug('no file key found, we assume that the file "{file}" is not encrypted',
-				['file' => $path, 'app' => 'encryption']);
-
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * should the file be encrypted or not
-	 *
-	 * @param string $path
-	 * @return boolean
-	 */
-	public function shouldEncrypt($path) {
-		if ($this->util->shouldEncryptHomeStorage() === false) {
-			$storage = $this->util->getStorage($path);
-			if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
-				return false;
-			}
-		}
-		$parts = explode('/', $path);
-		if (count($parts) < 4) {
-			return false;
-		}
-
-		if ($parts[2] === 'files') {
-			return true;
-		}
-		if ($parts[2] === 'files_versions') {
-			return true;
-		}
-		if ($parts[2] === 'files_trashbin') {
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * get size of the unencrypted payload per block.
-	 * Nextcloud read/write files with a block size of 8192 byte
-	 *
-	 * @param bool $signed
-	 * @return int
-	 */
-	public function getUnencryptedBlockSize($signed = false) {
-		if ($signed === false) {
-			return $this->unencryptedBlockSize;
-		}
-
-		return $this->unencryptedBlockSizeSigned;
-	}
-
-	/**
-	 * check if the encryption module is able to read the file,
-	 * e.g. if all encryption keys exists
-	 *
-	 * @param string $path
-	 * @param string $uid user for whom we want to check if he can read the file
-	 * @return bool
-	 * @throws DecryptionFailedException
-	 */
-	public function isReadable($path, $uid) {
-		$fileKey = $this->keyManager->getFileKey($path, $uid);
-		if (empty($fileKey)) {
-			$owner = $this->util->getOwner($path);
-			if ($owner !== $uid) {
-				// if it is a shared file we throw a exception with a useful
-				// error message because in this case it means that the file was
-				// shared with the user at a point where the user didn't had a
-				// valid private/public key
-				$msg = 'Encryption module "' . $this->getDisplayName() .
-					'" is not able to read ' . $path;
-				$hint = $this->l->t('Can not read this file, probably this is a shared file. Please ask the file owner to reshare the file with you.');
-				$this->logger->warning($msg);
-				throw new DecryptionFailedException($msg, $hint);
-			}
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Initial encryption of all files
-	 *
-	 * @param InputInterface $input
-	 * @param OutputInterface $output write some status information to the terminal during encryption
-	 */
-	public function encryptAll(InputInterface $input, OutputInterface $output) {
-		$this->encryptAll->encryptAll($input, $output);
-	}
-
-	/**
-	 * prepare module to perform decrypt all operation
-	 *
-	 * @param InputInterface $input
-	 * @param OutputInterface $output
-	 * @param string $user
-	 * @return bool
-	 */
-	public function prepareDecryptAll(InputInterface $input, OutputInterface $output, $user = '') {
-		return $this->decryptAll->prepare($input, $output, $user);
-	}
-
-
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	protected function getPathToRealFile($path) {
-		$realPath = $path;
-		$parts = explode('/', $path);
-		if ($parts[2] === 'files_versions') {
-			$realPath = '/' . $parts[1] . '/files/' . implode('/', array_slice($parts, 3));
-			$length = strrpos($realPath, '.');
-			$realPath = substr($realPath, 0, $length);
-		}
-
-		return $realPath;
-	}
-
-	/**
-	 * remove .part file extension and the ocTransferId from the file to get the
-	 * original file name
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	protected function stripPartFileExtension($path) {
-		if (pathinfo($path, PATHINFO_EXTENSION) === 'part') {
-			$pos = strrpos($path, '.', -6);
-			$path = substr($path, 0, $pos);
-		}
-
-		return $path;
-	}
-
-	/**
-	 * get owner of a file
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	protected function getOwner($path) {
-		if (!isset($this->owner[$path])) {
-			$this->owner[$path] = $this->util->getOwner($path);
-		}
-		return $this->owner[$path];
-	}
-
-	/**
-	 * Check if the module is ready to be used by that specific user.
-	 * In case a module is not ready - because e.g. key pairs have not been generated
-	 * upon login this method can return false before any operation starts and might
-	 * cause issues during operations.
-	 *
-	 * @param string $user
-	 * @return boolean
-	 * @since 9.1.0
-	 */
-	public function isReadyForUser($user) {
-		return $this->keyManager->userHasKeys($user);
-	}
-
-	/**
-	 * We only need a detailed access list if the master key is not enabled
-	 *
-	 * @return bool
-	 */
-	public function needDetailedAccessList() {
-		return !$this->util->isMasterKeyEnabled();
-	}
+    const ID = 'OC_DEFAULT_MODULE';
+    const DISPLAY_NAME = 'Default encryption module';
+
+    /**
+     * @var Crypt
+     */
+    private $crypt;
+
+    /** @var string */
+    private $cipher;
+
+    /** @var string */
+    private $path;
+
+    /** @var string */
+    private $user;
+
+    /** @var  array */
+    private $owner;
+
+    /** @var string */
+    private $fileKey;
+
+    /** @var string */
+    private $writeCache;
+
+    /** @var KeyManager */
+    private $keyManager;
+
+    /** @var array */
+    private $accessList;
+
+    /** @var boolean */
+    private $isWriteOperation;
+
+    /** @var Util */
+    private $util;
+
+    /** @var  Session */
+    private $session;
+
+    /** @var  ILogger */
+    private $logger;
+
+    /** @var IL10N */
+    private $l;
+
+    /** @var EncryptAll */
+    private $encryptAll;
+
+    /** @var  bool */
+    private $useMasterPassword;
+
+    /** @var DecryptAll  */
+    private $decryptAll;
+
+    /** @var int unencrypted block size if block contains signature */
+    private $unencryptedBlockSizeSigned = 6072;
+
+    /** @var int unencrypted block size */
+    private $unencryptedBlockSize = 6126;
+
+    /** @var int Current version of the file */
+    private $version = 0;
+
+    /** @var array remember encryption signature version */
+    private static $rememberVersion = [];
+
+
+    /**
+     *
+     * @param Crypt $crypt
+     * @param KeyManager $keyManager
+     * @param Util $util
+     * @param Session $session
+     * @param EncryptAll $encryptAll
+     * @param DecryptAll $decryptAll
+     * @param ILogger $logger
+     * @param IL10N $il10n
+     */
+    public function __construct(Crypt $crypt,
+                                KeyManager $keyManager,
+                                Util $util,
+                                Session $session,
+                                EncryptAll $encryptAll,
+                                DecryptAll $decryptAll,
+                                ILogger $logger,
+                                IL10N $il10n) {
+        $this->crypt = $crypt;
+        $this->keyManager = $keyManager;
+        $this->util = $util;
+        $this->session = $session;
+        $this->encryptAll = $encryptAll;
+        $this->decryptAll = $decryptAll;
+        $this->logger = $logger;
+        $this->l = $il10n;
+        $this->owner = [];
+        $this->useMasterPassword = $util->isMasterKeyEnabled();
+    }
+
+    /**
+     * @return string defining the technical unique id
+     */
+    public function getId() {
+        return self::ID;
+    }
+
+    /**
+     * In comparison to getKey() this function returns a human readable (maybe translated) name
+     *
+     * @return string
+     */
+    public function getDisplayName() {
+        return self::DISPLAY_NAME;
+    }
+
+    /**
+     * start receiving chunks from a file. This is the place where you can
+     * perform some initial step before starting encrypting/decrypting the
+     * chunks
+     *
+     * @param string $path to the file
+     * @param string $user who read/write the file
+     * @param string $mode php stream open mode
+     * @param array $header contains the header data read from the file
+     * @param array $accessList who has access to the file contains the key 'users' and 'public'
+     *
+     * @return array $header contain data as key-value pairs which should be
+     *                       written to the header, in case of a write operation
+     *                       or if no additional data is needed return a empty array
+     */
+    public function begin($path, $user, $mode, array $header, array $accessList) {
+        $this->path = $this->getPathToRealFile($path);
+        $this->accessList = $accessList;
+        $this->user = $user;
+        $this->isWriteOperation = false;
+        $this->writeCache = '';
+
+        if($this->session->isReady() === false) {
+            // if the master key is enabled we can initialize encryption
+            // with a empty password and user name
+            if ($this->util->isMasterKeyEnabled()) {
+                $this->keyManager->init('', '');
+            }
+        }
+
+        if ($this->session->decryptAllModeActivated()) {
+            $encryptedFileKey = $this->keyManager->getEncryptedFileKey($this->path);
+            $shareKey = $this->keyManager->getShareKey($this->path, $this->session->getDecryptAllUid());
+            $this->fileKey = $this->crypt->multiKeyDecrypt($encryptedFileKey,
+                $shareKey,
+                $this->session->getDecryptAllKey());
+        } else {
+            $this->fileKey = $this->keyManager->getFileKey($this->path, $this->user);
+        }
+
+        // always use the version from the original file, also part files
+        // need to have a correct version number if they get moved over to the
+        // final location
+        $this->version = (int)$this->keyManager->getVersion($this->stripPartFileExtension($path), new View());
+
+        if (
+            $mode === 'w'
+            || $mode === 'w+'
+            || $mode === 'wb'
+            || $mode === 'wb+'
+        ) {
+            $this->isWriteOperation = true;
+            if (empty($this->fileKey)) {
+                $this->fileKey = $this->crypt->generateFileKey();
+            }
+        } else {
+            // if we read a part file we need to increase the version by 1
+            // because the version number was also increased by writing
+            // the part file
+            if(Scanner::isPartialFile($path)) {
+                $this->version = $this->version + 1;
+            }
+        }
+
+        if ($this->isWriteOperation) {
+            $this->cipher = $this->crypt->getCipher();
+        } elseif (isset($header['cipher'])) {
+            $this->cipher = $header['cipher'];
+        } else {
+            // if we read a file without a header we fall-back to the legacy cipher
+            // which was used in <=oC6
+            $this->cipher = $this->crypt->getLegacyCipher();
+        }
+
+        return ['cipher' => $this->cipher, 'signed' => 'true'];
+    }
+
+    /**
+     * last chunk received. This is the place where you can perform some final
+     * operation and return some remaining data if something is left in your
+     * buffer.
+     *
+     * @param string $path to the file
+     * @param int $position
+     * @return string remained data which should be written to the file in case
+     *                of a write operation
+     * @throws PublicKeyMissingException
+     * @throws \Exception
+     * @throws \OCA\Encryption\Exceptions\MultiKeyEncryptException
+     */
+    public function end($path, $position = 0) {
+        $result = '';
+        if ($this->isWriteOperation) {
+            // in case of a part file we remember the new signature versions
+            // the version will be set later on update.
+            // This way we make sure that other apps listening to the pre-hooks
+            // still get the old version which should be the correct value for them
+            if (Scanner::isPartialFile($path)) {
+                self::$rememberVersion[$this->stripPartFileExtension($path)] = $this->version + 1;
+            }
+            if (!empty($this->writeCache)) {
+                $result = $this->crypt->symmetricEncryptFileContent($this->writeCache, $this->fileKey, $this->version + 1, $position);
+                $this->writeCache = '';
+            }
+            $publicKeys = [];
+            if ($this->useMasterPassword === true) {
+                $publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey();
+            } else {
+                foreach ($this->accessList['users'] as $uid) {
+                    try {
+                        $publicKeys[$uid] = $this->keyManager->getPublicKey($uid);
+                    } catch (PublicKeyMissingException $e) {
+                        $this->logger->warning(
+                            'no public key found for user "{uid}", user will not be able to read the file',
+                            ['app' => 'encryption', 'uid' => $uid]
+                        );
+                        // if the public key of the owner is missing we should fail
+                        if ($uid === $this->user) {
+                            throw $e;
+                        }
+                    }
+                }
+            }
+
+            $publicKeys = $this->keyManager->addSystemKeys($this->accessList, $publicKeys, $this->getOwner($path));
+            $encryptedKeyfiles = $this->crypt->multiKeyEncrypt($this->fileKey, $publicKeys);
+            $this->keyManager->setAllFileKeys($this->path, $encryptedKeyfiles);
+        }
+        return $result;
+    }
+
+
+
+    /**
+     * encrypt data
+     *
+     * @param string $data you want to encrypt
+     * @param int $position
+     * @return string encrypted data
+     */
+    public function encrypt($data, $position = 0) {
+        // If extra data is left over from the last round, make sure it
+        // is integrated into the next block
+        if ($this->writeCache) {
+
+            // Concat writeCache to start of $data
+            $data = $this->writeCache . $data;
+
+            // Clear the write cache, ready for reuse - it has been
+            // flushed and its old contents processed
+            $this->writeCache = '';
+
+        }
+
+        $encrypted = '';
+        // While there still remains some data to be processed & written
+        while (strlen($data) > 0) {
+
+            // Remaining length for this iteration, not of the
+            // entire file (may be greater than 8192 bytes)
+            $remainingLength = strlen($data);
+
+            // If data remaining to be written is less than the
+            // size of 1 6126 byte block
+            if ($remainingLength < $this->unencryptedBlockSizeSigned) {
+
+                // Set writeCache to contents of $data
+                // The writeCache will be carried over to the
+                // next write round, and added to the start of
+                // $data to ensure that written blocks are
+                // always the correct length. If there is still
+                // data in writeCache after the writing round
+                // has finished, then the data will be written
+                // to disk by $this->flush().
+                $this->writeCache = $data;
+
+                // Clear $data ready for next round
+                $data = '';
+
+            } else {
+
+                // Read the chunk from the start of $data
+                $chunk = substr($data, 0, $this->unencryptedBlockSizeSigned);
+
+                $encrypted .= $this->crypt->symmetricEncryptFileContent($chunk, $this->fileKey, $this->version + 1, $position);
+
+                // Remove the chunk we just processed from
+                // $data, leaving only unprocessed data in $data
+                // var, for handling on the next round
+                $data = substr($data, $this->unencryptedBlockSizeSigned);
+
+            }
+
+        }
+
+        return $encrypted;
+    }
+
+    /**
+     * decrypt data
+     *
+     * @param string $data you want to decrypt
+     * @param int $position
+     * @return string decrypted data
+     * @throws DecryptionFailedException
+     */
+    public function decrypt($data, $position = 0) {
+        if (empty($this->fileKey)) {
+            $msg = 'Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.';
+            $hint = $this->l->t('Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.');
+            $this->logger->error($msg);
+
+            throw new DecryptionFailedException($msg, $hint);
+        }
+
+        return $this->crypt->symmetricDecryptFileContent($data, $this->fileKey, $this->cipher, $this->version, $position);
+    }
+
+    /**
+     * update encrypted file, e.g. give additional users access to the file
+     *
+     * @param string $path path to the file which should be updated
+     * @param string $uid of the user who performs the operation
+     * @param array $accessList who has access to the file contains the key 'users' and 'public'
+     * @return boolean
+     */
+    public function update($path, $uid, array $accessList) {
+
+        if (empty($accessList)) {
+            if (isset(self::$rememberVersion[$path])) {
+                $this->keyManager->setVersion($path, self::$rememberVersion[$path], new View());
+                unset(self::$rememberVersion[$path]);
+            }
+            return;
+        }
+
+        $fileKey = $this->keyManager->getFileKey($path, $uid);
+
+        if (!empty($fileKey)) {
+
+            $publicKeys = [];
+            if ($this->useMasterPassword === true) {
+                $publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey();
+            } else {
+                foreach ($accessList['users'] as $user) {
+                    try {
+                        $publicKeys[$user] = $this->keyManager->getPublicKey($user);
+                    } catch (PublicKeyMissingException $e) {
+                        $this->logger->warning('Could not encrypt file for ' . $user . ': ' . $e->getMessage());
+                    }
+                }
+            }
+
+            $publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $this->getOwner($path));
+
+            $encryptedFileKey = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys);
+
+            $this->keyManager->deleteAllFileKeys($path);
+
+            $this->keyManager->setAllFileKeys($path, $encryptedFileKey);
+
+        } else {
+            $this->logger->debug('no file key found, we assume that the file "{file}" is not encrypted',
+                ['file' => $path, 'app' => 'encryption']);
+
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * should the file be encrypted or not
+     *
+     * @param string $path
+     * @return boolean
+     */
+    public function shouldEncrypt($path) {
+        if ($this->util->shouldEncryptHomeStorage() === false) {
+            $storage = $this->util->getStorage($path);
+            if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
+                return false;
+            }
+        }
+        $parts = explode('/', $path);
+        if (count($parts) < 4) {
+            return false;
+        }
+
+        if ($parts[2] === 'files') {
+            return true;
+        }
+        if ($parts[2] === 'files_versions') {
+            return true;
+        }
+        if ($parts[2] === 'files_trashbin') {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * get size of the unencrypted payload per block.
+     * Nextcloud read/write files with a block size of 8192 byte
+     *
+     * @param bool $signed
+     * @return int
+     */
+    public function getUnencryptedBlockSize($signed = false) {
+        if ($signed === false) {
+            return $this->unencryptedBlockSize;
+        }
+
+        return $this->unencryptedBlockSizeSigned;
+    }
+
+    /**
+     * check if the encryption module is able to read the file,
+     * e.g. if all encryption keys exists
+     *
+     * @param string $path
+     * @param string $uid user for whom we want to check if he can read the file
+     * @return bool
+     * @throws DecryptionFailedException
+     */
+    public function isReadable($path, $uid) {
+        $fileKey = $this->keyManager->getFileKey($path, $uid);
+        if (empty($fileKey)) {
+            $owner = $this->util->getOwner($path);
+            if ($owner !== $uid) {
+                // if it is a shared file we throw a exception with a useful
+                // error message because in this case it means that the file was
+                // shared with the user at a point where the user didn't had a
+                // valid private/public key
+                $msg = 'Encryption module "' . $this->getDisplayName() .
+                    '" is not able to read ' . $path;
+                $hint = $this->l->t('Can not read this file, probably this is a shared file. Please ask the file owner to reshare the file with you.');
+                $this->logger->warning($msg);
+                throw new DecryptionFailedException($msg, $hint);
+            }
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Initial encryption of all files
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output write some status information to the terminal during encryption
+     */
+    public function encryptAll(InputInterface $input, OutputInterface $output) {
+        $this->encryptAll->encryptAll($input, $output);
+    }
+
+    /**
+     * prepare module to perform decrypt all operation
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @param string $user
+     * @return bool
+     */
+    public function prepareDecryptAll(InputInterface $input, OutputInterface $output, $user = '') {
+        return $this->decryptAll->prepare($input, $output, $user);
+    }
+
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    protected function getPathToRealFile($path) {
+        $realPath = $path;
+        $parts = explode('/', $path);
+        if ($parts[2] === 'files_versions') {
+            $realPath = '/' . $parts[1] . '/files/' . implode('/', array_slice($parts, 3));
+            $length = strrpos($realPath, '.');
+            $realPath = substr($realPath, 0, $length);
+        }
+
+        return $realPath;
+    }
+
+    /**
+     * remove .part file extension and the ocTransferId from the file to get the
+     * original file name
+     *
+     * @param string $path
+     * @return string
+     */
+    protected function stripPartFileExtension($path) {
+        if (pathinfo($path, PATHINFO_EXTENSION) === 'part') {
+            $pos = strrpos($path, '.', -6);
+            $path = substr($path, 0, $pos);
+        }
+
+        return $path;
+    }
+
+    /**
+     * get owner of a file
+     *
+     * @param string $path
+     * @return string
+     */
+    protected function getOwner($path) {
+        if (!isset($this->owner[$path])) {
+            $this->owner[$path] = $this->util->getOwner($path);
+        }
+        return $this->owner[$path];
+    }
+
+    /**
+     * Check if the module is ready to be used by that specific user.
+     * In case a module is not ready - because e.g. key pairs have not been generated
+     * upon login this method can return false before any operation starts and might
+     * cause issues during operations.
+     *
+     * @param string $user
+     * @return boolean
+     * @since 9.1.0
+     */
+    public function isReadyForUser($user) {
+        return $this->keyManager->userHasKeys($user);
+    }
+
+    /**
+     * We only need a detailed access list if the master key is not enabled
+     *
+     * @return bool
+     */
+    public function needDetailedAccessList() {
+        return !$this->util->isMasterKeyEnabled();
+    }
 }