nextcloud / server

lib/private/Encryption/Exceptions/EmptyEncryptionDataException.php

Spacing +1 added lines, -1 removed lines

@@ -26,6 +26,6 @@
 
 use OCP\Encryption\Exceptions\GenericEncryptionException;
 
-class EmptyEncryptionDataException extends GenericEncryptionException{
+class EmptyEncryptionDataException extends GenericEncryptionException {
 
 }

lib/private/Encryption/File.php

Spacing +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
 		// always add owner to the list of users with access to the file
 		$userIds = array($owner);
 
-		if (!$this->util->isFile($owner . '/' . $ownerPath)) {
+		if (!$this->util->isFile($owner.'/'.$ownerPath)) {
 			return array('users' => $userIds, 'public' => false);
 		}
 

Indentation +90 added lines, -90 removed lines

@@ -31,95 +31,95 @@
 
 class File implements \OCP\Encryption\IFile {
 
-	/** @var Util */
-	protected $util;
-
-	/** @var IRootFolder */
-	private $rootFolder;
-
-	/** @var IManager */
-	private $shareManager;
-
-	/**
-	 * cache results of already checked folders
-	 *
-	 * @var array
-	 */
-	protected $cache;
-
-	public function __construct(Util $util,
-								IRootFolder $rootFolder,
-								IManager $shareManager) {
-		$this->util = $util;
-		$this->cache = new CappedMemoryCache();
-		$this->rootFolder = $rootFolder;
-		$this->shareManager = $shareManager;
-	}
-
-
-	/**
-	 * get list of users with access to the file
-	 *
-	 * @param string $path to the file
-	 * @return array  ['users' => $uniqueUserIds, 'public' => $public]
-	 */
-	public function getAccessList($path) {
-
-		// Make sure that a share key is generated for the owner too
-		list($owner, $ownerPath) = $this->util->getUidAndFilename($path);
-
-		// always add owner to the list of users with access to the file
-		$userIds = array($owner);
-
-		if (!$this->util->isFile($owner . '/' . $ownerPath)) {
-			return array('users' => $userIds, 'public' => false);
-		}
-
-		$ownerPath = substr($ownerPath, strlen('/files'));
-		$userFolder = $this->rootFolder->getUserFolder($owner);
-		try {
-			$file = $userFolder->get($ownerPath);
-		} catch (NotFoundException $e) {
-			$file = null;
-		}
-		$ownerPath = $this->util->stripPartialFileExtension($ownerPath);
-
-		// first get the shares for the parent and cache the result so that we don't
-		// need to check all parents for every file
-		$parent = dirname($ownerPath);
-		$parentNode = $userFolder->get($parent);
-		if (isset($this->cache[$parent])) {
-			$resultForParents = $this->cache[$parent];
-		} else {
-			$resultForParents = $this->shareManager->getAccessList($parentNode);
-			$this->cache[$parent] = $resultForParents;
-		}
-		$userIds = array_merge($userIds, $resultForParents['users']);
-		$public = $resultForParents['public'] || $resultForParents['remote'];
-
-
-		// Find out who, if anyone, is sharing the file
-		if ($file !== null) {
-			$resultForFile = $this->shareManager->getAccessList($file, false);
-			$userIds = array_merge($userIds, $resultForFile['users']);
-			$public = $resultForFile['public'] || $resultForFile['remote'] || $public;
-		}
-
-		// check if it is a group mount
-		if (\OCP\App::isEnabled("files_external")) {
-			$mounts = \OC_Mount_Config::getSystemMountPoints();
-			foreach ($mounts as $mount) {
-				if ($mount['mountpoint'] == substr($ownerPath, 1, strlen($mount['mountpoint']))) {
-					$mountedFor = $this->util->getUserWithAccessToMountPoint($mount['applicable']['users'], $mount['applicable']['groups']);
-					$userIds = array_merge($userIds, $mountedFor);
-				}
-			}
-		}
-
-		// Remove duplicate UIDs
-		$uniqueUserIds = array_unique($userIds);
-
-		return array('users' => $uniqueUserIds, 'public' => $public);
-	}
+    /** @var Util */
+    protected $util;
+
+    /** @var IRootFolder */
+    private $rootFolder;
+
+    /** @var IManager */
+    private $shareManager;
+
+    /**
+     * cache results of already checked folders
+     *
+     * @var array
+     */
+    protected $cache;
+
+    public function __construct(Util $util,
+                                IRootFolder $rootFolder,
+                                IManager $shareManager) {
+        $this->util = $util;
+        $this->cache = new CappedMemoryCache();
+        $this->rootFolder = $rootFolder;
+        $this->shareManager = $shareManager;
+    }
+
+
+    /**
+     * get list of users with access to the file
+     *
+     * @param string $path to the file
+     * @return array  ['users' => $uniqueUserIds, 'public' => $public]
+     */
+    public function getAccessList($path) {
+
+        // Make sure that a share key is generated for the owner too
+        list($owner, $ownerPath) = $this->util->getUidAndFilename($path);
+
+        // always add owner to the list of users with access to the file
+        $userIds = array($owner);
+
+        if (!$this->util->isFile($owner . '/' . $ownerPath)) {
+            return array('users' => $userIds, 'public' => false);
+        }
+
+        $ownerPath = substr($ownerPath, strlen('/files'));
+        $userFolder = $this->rootFolder->getUserFolder($owner);
+        try {
+            $file = $userFolder->get($ownerPath);
+        } catch (NotFoundException $e) {
+            $file = null;
+        }
+        $ownerPath = $this->util->stripPartialFileExtension($ownerPath);
+
+        // first get the shares for the parent and cache the result so that we don't
+        // need to check all parents for every file
+        $parent = dirname($ownerPath);
+        $parentNode = $userFolder->get($parent);
+        if (isset($this->cache[$parent])) {
+            $resultForParents = $this->cache[$parent];
+        } else {
+            $resultForParents = $this->shareManager->getAccessList($parentNode);
+            $this->cache[$parent] = $resultForParents;
+        }
+        $userIds = array_merge($userIds, $resultForParents['users']);
+        $public = $resultForParents['public'] || $resultForParents['remote'];
+
+
+        // Find out who, if anyone, is sharing the file
+        if ($file !== null) {
+            $resultForFile = $this->shareManager->getAccessList($file, false);
+            $userIds = array_merge($userIds, $resultForFile['users']);
+            $public = $resultForFile['public'] || $resultForFile['remote'] || $public;
+        }
+
+        // check if it is a group mount
+        if (\OCP\App::isEnabled("files_external")) {
+            $mounts = \OC_Mount_Config::getSystemMountPoints();
+            foreach ($mounts as $mount) {
+                if ($mount['mountpoint'] == substr($ownerPath, 1, strlen($mount['mountpoint']))) {
+                    $mountedFor = $this->util->getUserWithAccessToMountPoint($mount['applicable']['users'], $mount['applicable']['groups']);
+                    $userIds = array_merge($userIds, $mountedFor);
+                }
+            }
+        }
+
+        // Remove duplicate UIDs
+        $uniqueUserIds = array_unique($userIds);
+
+        return array('users' => $uniqueUserIds, 'public' => $public);
+    }
 
 }

lib/private/Encryption/Keys/Storage.php

Spacing +19 added lines, -19 removed lines

@@ -66,8 +66,8 @@ 
 		$this->util = $util;
 
 		$this->encryption_base_dir = '/files_encryption';
-		$this->keys_base_dir = $this->encryption_base_dir .'/keys';
-		$this->backup_base_dir = $this->encryption_base_dir .'/backup';
+		$this->keys_base_dir = $this->encryption_base_dir.'/keys';
+		$this->backup_base_dir = $this->encryption_base_dir.'/backup';
 		$this->root_dir = $this->util->getKeyStorageRoot();
 	}
 
@@ -85,14 +85,14 @@ 
 	public function getFileKey($path, $keyId, $encryptionModuleId) {
 		$realFile = $this->util->stripPartialFileExtension($path);
 		$keyDir = $this->getFileKeyDir($encryptionModuleId, $realFile);
-		$key = $this->getKey($keyDir . $keyId);
+		$key = $this->getKey($keyDir.$keyId);
 
 		if ($key === '' && $realFile !== $path) {
 			// Check if the part file has keys and use them, if no normal keys
 			// exist. This is required to fix copyBetweenStorage() when we
 			// rename a .part file over storage borders.
 			$keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
-			$key = $this->getKey($keyDir . $keyId);
+			$key = $this->getKey($keyDir.$keyId);
 		}
 
 		return $key;
@@ -119,7 +119,7 @@ 
 	 */
 	public function setFileKey($path, $keyId, $key, $encryptionModuleId) {
 		$keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
-		return $this->setKey($keyDir . $keyId, $key);
+		return $this->setKey($keyDir.$keyId, $key);
 	}
 
 	/**
@@ -143,7 +143,7 @@ 
 	 */
 	public function deleteFileKey($path, $keyId, $encryptionModuleId) {
 		$keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
-		return !$this->view->file_exists($keyDir . $keyId) || $this->view->unlink($keyDir . $keyId);
+		return !$this->view->file_exists($keyDir.$keyId) || $this->view->unlink($keyDir.$keyId);
 	}
 
 	/**
@@ -173,10 +173,10 @@ 
 	protected function constructUserKeyPath($encryptionModuleId, $keyId, $uid) {
 
 		if ($uid === null) {
-			$path = $this->root_dir . '/' . $this->encryption_base_dir . '/' . $encryptionModuleId . '/' . $keyId;
+			$path = $this->root_dir.'/'.$this->encryption_base_dir.'/'.$encryptionModuleId.'/'.$keyId;
 		} else {
-			$path = $this->root_dir . '/' . $uid . $this->encryption_base_dir . '/'
-				. $encryptionModuleId . '/' . $uid . '.' . $keyId;
+			$path = $this->root_dir.'/'.$uid.$this->encryption_base_dir.'/'
+				. $encryptionModuleId.'/'.$uid.'.'.$keyId;
 		}
 
 		return \OC\Files\Filesystem::normalizePath($path);
@@ -194,7 +194,7 @@ 
 
 		if ($this->view->file_exists($path)) {
 			if (isset($this->keyCache[$path])) {
-				$key =  $this->keyCache[$path];
+				$key = $this->keyCache[$path];
 			} else {
 				$key = $this->view->file_get_contents($path);
 				$this->keyCache[$path] = $key;
@@ -238,12 +238,12 @@ 
 
 		// in case of system wide mount points the keys are stored directly in the data directory
 		if ($this->util->isSystemWideMountPoint($filename, $owner)) {
-			$keyPath = $this->root_dir . '/' . $this->keys_base_dir . $filename . '/';
+			$keyPath = $this->root_dir.'/'.$this->keys_base_dir.$filename.'/';
 		} else {
-			$keyPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $filename . '/';
+			$keyPath = $this->root_dir.'/'.$owner.$this->keys_base_dir.$filename.'/';
 		}
 
-		return Filesystem::normalizePath($keyPath . $encryptionModuleId . '/', false);
+		return Filesystem::normalizePath($keyPath.$encryptionModuleId.'/', false);
 	}
 
 	/**
@@ -300,13 +300,13 @@ 
 	 * @since 12.0.0
 	 */
 	public function backupUserKeys($encryptionModuleId, $purpose, $uid) {
-		$source = $uid . $this->encryption_base_dir . '/' . $encryptionModuleId;
-		$backupDir = $uid . $this->backup_base_dir;
+		$source = $uid.$this->encryption_base_dir.'/'.$encryptionModuleId;
+		$backupDir = $uid.$this->backup_base_dir;
 		if (!$this->view->file_exists($backupDir)) {
 			$this->view->mkdir($backupDir);
 		}
 
-		$backupDir = $backupDir . '/' . $purpose . '.' . $encryptionModuleId . '.' . $this->getTimestamp();
+		$backupDir = $backupDir.'/'.$purpose.'.'.$encryptionModuleId.'.'.$this->getTimestamp();
 		$this->view->mkdir($backupDir);
 
 		return $this->view->copy($source, $backupDir);
@@ -332,9 +332,9 @@ 
 		$systemWideMountPoint = $this->util->isSystemWideMountPoint($relativePath, $owner);
 
 		if ($systemWideMountPoint) {
-			$systemPath = $this->root_dir . '/' . $this->keys_base_dir . $relativePath . '/';
+			$systemPath = $this->root_dir.'/'.$this->keys_base_dir.$relativePath.'/';
 		} else {
-			$systemPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $relativePath . '/';
+			$systemPath = $this->root_dir.'/'.$owner.$this->keys_base_dir.$relativePath.'/';
 		}
 
 		return  Filesystem::normalizePath($systemPath, false);
@@ -351,7 +351,7 @@ 
 			$sub_dirs = explode('/', ltrim($path, '/'));
 			$dir = '';
 			foreach ($sub_dirs as $sub_dir) {
-				$dir .= '/' . $sub_dir;
+				$dir .= '/'.$sub_dir;
 				if (!$this->view->is_dir($dir)) {
 					$this->view->mkdir($dir);
 				}

Indentation +340 added lines, -340 removed lines

@@ -32,345 +32,345 @@
 
 class Storage implements IStorage {
 
-	// hidden file which indicate that the folder is a valid key storage
-	const KEY_STORAGE_MARKER = '.oc_key_storage';
-
-	/** @var View */
-	private $view;
-
-	/** @var Util */
-	private $util;
-
-	// base dir where all the file related keys are stored
-	/** @var string */
-	private $keys_base_dir;
-
-	// root of the key storage default is empty which means that we use the data folder
-	/** @var string */
-	private $root_dir;
-
-	/** @var string */
-	private $encryption_base_dir;
-
-	/** @var string */
-	private $backup_base_dir;
-
-	/** @var array */
-	private $keyCache = [];
-
-	/**
-	 * @param View $view
-	 * @param Util $util
-	 */
-	public function __construct(View $view, Util $util) {
-		$this->view = $view;
-		$this->util = $util;
-
-		$this->encryption_base_dir = '/files_encryption';
-		$this->keys_base_dir = $this->encryption_base_dir .'/keys';
-		$this->backup_base_dir = $this->encryption_base_dir .'/backup';
-		$this->root_dir = $this->util->getKeyStorageRoot();
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getUserKey($uid, $keyId, $encryptionModuleId) {
-		$path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid);
-		return $this->getKey($path);
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getFileKey($path, $keyId, $encryptionModuleId) {
-		$realFile = $this->util->stripPartialFileExtension($path);
-		$keyDir = $this->getFileKeyDir($encryptionModuleId, $realFile);
-		$key = $this->getKey($keyDir . $keyId);
-
-		if ($key === '' && $realFile !== $path) {
-			// Check if the part file has keys and use them, if no normal keys
-			// exist. This is required to fix copyBetweenStorage() when we
-			// rename a .part file over storage borders.
-			$keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
-			$key = $this->getKey($keyDir . $keyId);
-		}
-
-		return $key;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getSystemUserKey($keyId, $encryptionModuleId) {
-		$path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null);
-		return $this->getKey($path);
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function setUserKey($uid, $keyId, $key, $encryptionModuleId) {
-		$path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid);
-		return $this->setKey($path, $key);
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function setFileKey($path, $keyId, $key, $encryptionModuleId) {
-		$keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
-		return $this->setKey($keyDir . $keyId, $key);
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function setSystemUserKey($keyId, $key, $encryptionModuleId) {
-		$path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null);
-		return $this->setKey($path, $key);
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function deleteUserKey($uid, $keyId, $encryptionModuleId) {
-		try {
-			$path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid);
-			return !$this->view->file_exists($path) || $this->view->unlink($path);
-		} catch (NoUserException $e) {
-			// this exception can come from initMountPoints() from setupUserMounts()
-			// for a deleted user.
-			//
-			// It means, that:
-			// - we are not running in alternative storage mode because we don't call
-			// initMountPoints() in that mode
-			// - the keys were in the user's home but since the user was deleted, the
-			// user's home is gone and so are the keys
-			//
-			// So there is nothing to do, just ignore.
-		}
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function deleteFileKey($path, $keyId, $encryptionModuleId) {
-		$keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
-		return !$this->view->file_exists($keyDir . $keyId) || $this->view->unlink($keyDir . $keyId);
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function deleteAllFileKeys($path) {
-		$keyDir = $this->getFileKeyDir('', $path);
-		return !$this->view->file_exists($keyDir) || $this->view->deleteAll($keyDir);
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function deleteSystemUserKey($keyId, $encryptionModuleId) {
-		$path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null);
-		return !$this->view->file_exists($path) || $this->view->unlink($path);
-	}
-
-	/**
-	 * construct path to users key
-	 *
-	 * @param string $encryptionModuleId
-	 * @param string $keyId
-	 * @param string $uid
-	 * @return string
-	 */
-	protected function constructUserKeyPath($encryptionModuleId, $keyId, $uid) {
-
-		if ($uid === null) {
-			$path = $this->root_dir . '/' . $this->encryption_base_dir . '/' . $encryptionModuleId . '/' . $keyId;
-		} else {
-			$path = $this->root_dir . '/' . $uid . $this->encryption_base_dir . '/'
-				. $encryptionModuleId . '/' . $uid . '.' . $keyId;
-		}
-
-		return \OC\Files\Filesystem::normalizePath($path);
-	}
-
-	/**
-	 * read key from hard disk
-	 *
-	 * @param string $path to key
-	 * @return string
-	 */
-	private function getKey($path) {
-
-		$key = '';
-
-		if ($this->view->file_exists($path)) {
-			if (isset($this->keyCache[$path])) {
-				$key =  $this->keyCache[$path];
-			} else {
-				$key = $this->view->file_get_contents($path);
-				$this->keyCache[$path] = $key;
-			}
-		}
-
-		return $key;
-	}
-
-	/**
-	 * write key to disk
-	 *
-	 *
-	 * @param string $path path to key directory
-	 * @param string $key key
-	 * @return bool
-	 */
-	private function setKey($path, $key) {
-		$this->keySetPreparation(dirname($path));
-
-		$result = $this->view->file_put_contents($path, $key);
-
-		if (is_int($result) && $result > 0) {
-			$this->keyCache[$path] = $key;
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * get path to key folder for a given file
-	 *
-	 * @param string $encryptionModuleId
-	 * @param string $path path to the file, relative to data/
-	 * @return string
-	 */
-	private function getFileKeyDir($encryptionModuleId, $path) {
-
-		list($owner, $filename) = $this->util->getUidAndFilename($path);
-
-		// in case of system wide mount points the keys are stored directly in the data directory
-		if ($this->util->isSystemWideMountPoint($filename, $owner)) {
-			$keyPath = $this->root_dir . '/' . $this->keys_base_dir . $filename . '/';
-		} else {
-			$keyPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $filename . '/';
-		}
-
-		return Filesystem::normalizePath($keyPath . $encryptionModuleId . '/', false);
-	}
-
-	/**
-	 * move keys if a file was renamed
-	 *
-	 * @param string $source
-	 * @param string $target
-	 * @return boolean
-	 */
-	public function renameKeys($source, $target) {
-
-		$sourcePath = $this->getPathToKeys($source);
-		$targetPath = $this->getPathToKeys($target);
-
-		if ($this->view->file_exists($sourcePath)) {
-			$this->keySetPreparation(dirname($targetPath));
-			$this->view->rename($sourcePath, $targetPath);
-
-			return true;
-		}
-
-		return false;
-	}
-
-
-	/**
-	 * copy keys if a file was renamed
-	 *
-	 * @param string $source
-	 * @param string $target
-	 * @return boolean
-	 */
-	public function copyKeys($source, $target) {
-
-		$sourcePath = $this->getPathToKeys($source);
-		$targetPath = $this->getPathToKeys($target);
-
-		if ($this->view->file_exists($sourcePath)) {
-			$this->keySetPreparation(dirname($targetPath));
-			$this->view->copy($sourcePath, $targetPath);
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * backup keys of a given encryption module
-	 *
-	 * @param string $encryptionModuleId
-	 * @param string $purpose
-	 * @param string $uid
-	 * @return bool
-	 * @since 12.0.0
-	 */
-	public function backupUserKeys($encryptionModuleId, $purpose, $uid) {
-		$source = $uid . $this->encryption_base_dir . '/' . $encryptionModuleId;
-		$backupDir = $uid . $this->backup_base_dir;
-		if (!$this->view->file_exists($backupDir)) {
-			$this->view->mkdir($backupDir);
-		}
-
-		$backupDir = $backupDir . '/' . $purpose . '.' . $encryptionModuleId . '.' . $this->getTimestamp();
-		$this->view->mkdir($backupDir);
-
-		return $this->view->copy($source, $backupDir);
-	}
-
-	/**
-	 * get the current timestamp
-	 *
-	 * @return int
-	 */
-	protected function getTimestamp() {
-		return time();
-	}
-
-	/**
-	 * get system wide path and detect mount points
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	protected function getPathToKeys($path) {
-		list($owner, $relativePath) = $this->util->getUidAndFilename($path);
-		$systemWideMountPoint = $this->util->isSystemWideMountPoint($relativePath, $owner);
-
-		if ($systemWideMountPoint) {
-			$systemPath = $this->root_dir . '/' . $this->keys_base_dir . $relativePath . '/';
-		} else {
-			$systemPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $relativePath . '/';
-		}
-
-		return  Filesystem::normalizePath($systemPath, false);
-	}
-
-	/**
-	 * Make preparations to filesystem for saving a key file
-	 *
-	 * @param string $path relative to the views root
-	 */
-	protected function keySetPreparation($path) {
-		// If the file resides within a subdirectory, create it
-		if (!$this->view->file_exists($path)) {
-			$sub_dirs = explode('/', ltrim($path, '/'));
-			$dir = '';
-			foreach ($sub_dirs as $sub_dir) {
-				$dir .= '/' . $sub_dir;
-				if (!$this->view->is_dir($dir)) {
-					$this->view->mkdir($dir);
-				}
-			}
-		}
-	}
+    // hidden file which indicate that the folder is a valid key storage
+    const KEY_STORAGE_MARKER = '.oc_key_storage';
+
+    /** @var View */
+    private $view;
+
+    /** @var Util */
+    private $util;
+
+    // base dir where all the file related keys are stored
+    /** @var string */
+    private $keys_base_dir;
+
+    // root of the key storage default is empty which means that we use the data folder
+    /** @var string */
+    private $root_dir;
+
+    /** @var string */
+    private $encryption_base_dir;
+
+    /** @var string */
+    private $backup_base_dir;
+
+    /** @var array */
+    private $keyCache = [];
+
+    /**
+     * @param View $view
+     * @param Util $util
+     */
+    public function __construct(View $view, Util $util) {
+        $this->view = $view;
+        $this->util = $util;
+
+        $this->encryption_base_dir = '/files_encryption';
+        $this->keys_base_dir = $this->encryption_base_dir .'/keys';
+        $this->backup_base_dir = $this->encryption_base_dir .'/backup';
+        $this->root_dir = $this->util->getKeyStorageRoot();
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getUserKey($uid, $keyId, $encryptionModuleId) {
+        $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid);
+        return $this->getKey($path);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getFileKey($path, $keyId, $encryptionModuleId) {
+        $realFile = $this->util->stripPartialFileExtension($path);
+        $keyDir = $this->getFileKeyDir($encryptionModuleId, $realFile);
+        $key = $this->getKey($keyDir . $keyId);
+
+        if ($key === '' && $realFile !== $path) {
+            // Check if the part file has keys and use them, if no normal keys
+            // exist. This is required to fix copyBetweenStorage() when we
+            // rename a .part file over storage borders.
+            $keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
+            $key = $this->getKey($keyDir . $keyId);
+        }
+
+        return $key;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getSystemUserKey($keyId, $encryptionModuleId) {
+        $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null);
+        return $this->getKey($path);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function setUserKey($uid, $keyId, $key, $encryptionModuleId) {
+        $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid);
+        return $this->setKey($path, $key);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function setFileKey($path, $keyId, $key, $encryptionModuleId) {
+        $keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
+        return $this->setKey($keyDir . $keyId, $key);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function setSystemUserKey($keyId, $key, $encryptionModuleId) {
+        $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null);
+        return $this->setKey($path, $key);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function deleteUserKey($uid, $keyId, $encryptionModuleId) {
+        try {
+            $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid);
+            return !$this->view->file_exists($path) || $this->view->unlink($path);
+        } catch (NoUserException $e) {
+            // this exception can come from initMountPoints() from setupUserMounts()
+            // for a deleted user.
+            //
+            // It means, that:
+            // - we are not running in alternative storage mode because we don't call
+            // initMountPoints() in that mode
+            // - the keys were in the user's home but since the user was deleted, the
+            // user's home is gone and so are the keys
+            //
+            // So there is nothing to do, just ignore.
+        }
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function deleteFileKey($path, $keyId, $encryptionModuleId) {
+        $keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
+        return !$this->view->file_exists($keyDir . $keyId) || $this->view->unlink($keyDir . $keyId);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function deleteAllFileKeys($path) {
+        $keyDir = $this->getFileKeyDir('', $path);
+        return !$this->view->file_exists($keyDir) || $this->view->deleteAll($keyDir);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function deleteSystemUserKey($keyId, $encryptionModuleId) {
+        $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null);
+        return !$this->view->file_exists($path) || $this->view->unlink($path);
+    }
+
+    /**
+     * construct path to users key
+     *
+     * @param string $encryptionModuleId
+     * @param string $keyId
+     * @param string $uid
+     * @return string
+     */
+    protected function constructUserKeyPath($encryptionModuleId, $keyId, $uid) {
+
+        if ($uid === null) {
+            $path = $this->root_dir . '/' . $this->encryption_base_dir . '/' . $encryptionModuleId . '/' . $keyId;
+        } else {
+            $path = $this->root_dir . '/' . $uid . $this->encryption_base_dir . '/'
+                . $encryptionModuleId . '/' . $uid . '.' . $keyId;
+        }
+
+        return \OC\Files\Filesystem::normalizePath($path);
+    }
+
+    /**
+     * read key from hard disk
+     *
+     * @param string $path to key
+     * @return string
+     */
+    private function getKey($path) {
+
+        $key = '';
+
+        if ($this->view->file_exists($path)) {
+            if (isset($this->keyCache[$path])) {
+                $key =  $this->keyCache[$path];
+            } else {
+                $key = $this->view->file_get_contents($path);
+                $this->keyCache[$path] = $key;
+            }
+        }
+
+        return $key;
+    }
+
+    /**
+     * write key to disk
+     *
+     *
+     * @param string $path path to key directory
+     * @param string $key key
+     * @return bool
+     */
+    private function setKey($path, $key) {
+        $this->keySetPreparation(dirname($path));
+
+        $result = $this->view->file_put_contents($path, $key);
+
+        if (is_int($result) && $result > 0) {
+            $this->keyCache[$path] = $key;
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * get path to key folder for a given file
+     *
+     * @param string $encryptionModuleId
+     * @param string $path path to the file, relative to data/
+     * @return string
+     */
+    private function getFileKeyDir($encryptionModuleId, $path) {
+
+        list($owner, $filename) = $this->util->getUidAndFilename($path);
+
+        // in case of system wide mount points the keys are stored directly in the data directory
+        if ($this->util->isSystemWideMountPoint($filename, $owner)) {
+            $keyPath = $this->root_dir . '/' . $this->keys_base_dir . $filename . '/';
+        } else {
+            $keyPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $filename . '/';
+        }
+
+        return Filesystem::normalizePath($keyPath . $encryptionModuleId . '/', false);
+    }
+
+    /**
+     * move keys if a file was renamed
+     *
+     * @param string $source
+     * @param string $target
+     * @return boolean
+     */
+    public function renameKeys($source, $target) {
+
+        $sourcePath = $this->getPathToKeys($source);
+        $targetPath = $this->getPathToKeys($target);
+
+        if ($this->view->file_exists($sourcePath)) {
+            $this->keySetPreparation(dirname($targetPath));
+            $this->view->rename($sourcePath, $targetPath);
+
+            return true;
+        }
+
+        return false;
+    }
+
+
+    /**
+     * copy keys if a file was renamed
+     *
+     * @param string $source
+     * @param string $target
+     * @return boolean
+     */
+    public function copyKeys($source, $target) {
+
+        $sourcePath = $this->getPathToKeys($source);
+        $targetPath = $this->getPathToKeys($target);
+
+        if ($this->view->file_exists($sourcePath)) {
+            $this->keySetPreparation(dirname($targetPath));
+            $this->view->copy($sourcePath, $targetPath);
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * backup keys of a given encryption module
+     *
+     * @param string $encryptionModuleId
+     * @param string $purpose
+     * @param string $uid
+     * @return bool
+     * @since 12.0.0
+     */
+    public function backupUserKeys($encryptionModuleId, $purpose, $uid) {
+        $source = $uid . $this->encryption_base_dir . '/' . $encryptionModuleId;
+        $backupDir = $uid . $this->backup_base_dir;
+        if (!$this->view->file_exists($backupDir)) {
+            $this->view->mkdir($backupDir);
+        }
+
+        $backupDir = $backupDir . '/' . $purpose . '.' . $encryptionModuleId . '.' . $this->getTimestamp();
+        $this->view->mkdir($backupDir);
+
+        return $this->view->copy($source, $backupDir);
+    }
+
+    /**
+     * get the current timestamp
+     *
+     * @return int
+     */
+    protected function getTimestamp() {
+        return time();
+    }
+
+    /**
+     * get system wide path and detect mount points
+     *
+     * @param string $path
+     * @return string
+     */
+    protected function getPathToKeys($path) {
+        list($owner, $relativePath) = $this->util->getUidAndFilename($path);
+        $systemWideMountPoint = $this->util->isSystemWideMountPoint($relativePath, $owner);
+
+        if ($systemWideMountPoint) {
+            $systemPath = $this->root_dir . '/' . $this->keys_base_dir . $relativePath . '/';
+        } else {
+            $systemPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $relativePath . '/';
+        }
+
+        return  Filesystem::normalizePath($systemPath, false);
+    }
+
+    /**
+     * Make preparations to filesystem for saving a key file
+     *
+     * @param string $path relative to the views root
+     */
+    protected function keySetPreparation($path) {
+        // If the file resides within a subdirectory, create it
+        if (!$this->view->file_exists($path)) {
+            $sub_dirs = explode('/', ltrim($path, '/'));
+            $dir = '';
+            foreach ($sub_dirs as $sub_dir) {
+                $dir .= '/' . $sub_dir;
+                if (!$this->view->is_dir($dir)) {
+                    $this->view->mkdir($dir);
+                }
+            }
+        }
+    }
 
 }

lib/private/Encryption/Manager.php

Spacing +1 added lines, -1 removed lines

@@ -274,7 +274,7 @@
 		}
 
 		// check if key storage is mounted correctly
-		if ($this->rootView->file_exists($rootDir . '/' . Storage::KEY_STORAGE_MARKER)) {
+		if ($this->rootView->file_exists($rootDir.'/'.Storage::KEY_STORAGE_MARKER)) {
 			return true;
 		}
 

Indentation +236 added lines, -236 removed lines

@@ -39,242 +39,242 @@
 
 class Manager implements IManager {
 
-	/** @var array */
-	protected $encryptionModules;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var ILogger */
-	protected $logger;
-
-	/** @var Il10n */
-	protected $l;
-
-	/** @var View  */
-	protected $rootView;
-
-	/** @var Util  */
-	protected $util;
-
-	/** @var ArrayCache  */
-	protected $arrayCache;
-
-	/**
-	 * @param IConfig $config
-	 * @param ILogger $logger
-	 * @param IL10N $l10n
-	 * @param View $rootView
-	 * @param Util $util
-	 * @param ArrayCache $arrayCache
-	 */
-	public function __construct(IConfig $config, ILogger $logger, IL10N $l10n, View $rootView, Util $util, ArrayCache $arrayCache) {
-		$this->encryptionModules = array();
-		$this->config = $config;
-		$this->logger = $logger;
-		$this->l = $l10n;
-		$this->rootView = $rootView;
-		$this->util = $util;
-		$this->arrayCache = $arrayCache;
-	}
-
-	/**
-	 * Check if encryption is enabled
-	 *
-	 * @return bool true if enabled, false if not
-	 */
-	public function isEnabled() {
-
-		$installed = $this->config->getSystemValue('installed', false);
-		if (!$installed) {
-			return false;
-		}
-
-		$enabled = $this->config->getAppValue('core', 'encryption_enabled', 'no');
-		return $enabled === 'yes';
-	}
-
-	/**
-	 * check if new encryption is ready
-	 *
-	 * @return bool
-	 * @throws ServiceUnavailableException
-	 */
-	public function isReady() {
-
-		if ($this->isKeyStorageReady() === false) {
-			throw new ServiceUnavailableException('Key Storage is not ready');
-		}
-
-		return true;
-	}
-
-	/**
-	 * @param string $user
-	 */
-	public function isReadyForUser($user) {
-		if (!$this->isReady()) {
-			return false;
-		}
-
-		foreach ($this->getEncryptionModules() as $module) {
-			/** @var IEncryptionModule $m */
-			$m = call_user_func($module['callback']);
-			if (!$m->isReadyForUser($user)) {
-				return false;
-			}
-		}
-
-		return true;
-	}
-
-		/**
-	 * Registers an callback function which must return an encryption module instance
-	 *
-	 * @param string $id
-	 * @param string $displayName
-	 * @param callable $callback
-	 * @throws Exceptions\ModuleAlreadyExistsException
-	 */
-	public function registerEncryptionModule($id, $displayName, callable $callback) {
-
-		if (isset($this->encryptionModules[$id])) {
-			throw new Exceptions\ModuleAlreadyExistsException($id, $displayName);
-		}
-
-		$this->encryptionModules[$id] = [
-			'id' => $id,
-			'displayName' => $displayName,
-			'callback' => $callback,
-		];
-
-		$defaultEncryptionModuleId = $this->getDefaultEncryptionModuleId();
-
-		if (empty($defaultEncryptionModuleId)) {
-			$this->setDefaultEncryptionModule($id);
-		}
-	}
-
-	/**
-	 * Unregisters an encryption module
-	 *
-	 * @param string $moduleId
-	 */
-	public function unregisterEncryptionModule($moduleId) {
-		unset($this->encryptionModules[$moduleId]);
-	}
-
-	/**
-	 * get a list of all encryption modules
-	 *
-	 * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]]
-	 */
-	public function getEncryptionModules() {
-		return $this->encryptionModules;
-	}
-
-	/**
-	 * get a specific encryption module
-	 *
-	 * @param string $moduleId
-	 * @return IEncryptionModule
-	 * @throws Exceptions\ModuleDoesNotExistsException
-	 */
-	public function getEncryptionModule($moduleId = '') {
-		if (!empty($moduleId)) {
-			if (isset($this->encryptionModules[$moduleId])) {
-				return call_user_func($this->encryptionModules[$moduleId]['callback']);
-			} else {
-				$message = "Module with ID: $moduleId does not exist.";
-				$hint = $this->l->t('Module with ID: %s does not exist. Please enable it in your apps settings or contact your administrator.', [$moduleId]);
-				throw new Exceptions\ModuleDoesNotExistsException($message, $hint);
-			}
-		} else {
-			return $this->getDefaultEncryptionModule();
-		}
-	}
-
-	/**
-	 * get default encryption module
-	 *
-	 * @return \OCP\Encryption\IEncryptionModule
-	 * @throws Exceptions\ModuleDoesNotExistsException
-	 */
-	protected function getDefaultEncryptionModule() {
-		$defaultModuleId = $this->getDefaultEncryptionModuleId();
-		if (!empty($defaultModuleId)) {
-			if (isset($this->encryptionModules[$defaultModuleId])) {
-				return call_user_func($this->encryptionModules[$defaultModuleId]['callback']);
-			} else {
-				$message = 'Default encryption module not loaded';
-				throw new Exceptions\ModuleDoesNotExistsException($message);
-			}
-		} else {
-			$message = 'No default encryption module defined';
-			throw new Exceptions\ModuleDoesNotExistsException($message);
-		}
-
-	}
-
-	/**
-	 * set default encryption module Id
-	 *
-	 * @param string $moduleId
-	 * @return bool
-	 */
-	public function setDefaultEncryptionModule($moduleId) {
-		try {
-			$this->getEncryptionModule($moduleId);
-		} catch (\Exception $e) {
-			return false;
-		}
-
-		$this->config->setAppValue('core', 'default_encryption_module', $moduleId);
-		return true;
-	}
-
-	/**
-	 * get default encryption module Id
-	 *
-	 * @return string
-	 */
-	public function getDefaultEncryptionModuleId() {
-		return $this->config->getAppValue('core', 'default_encryption_module');
-	}
-
-	/**
-	 * Add storage wrapper
-	 */
-	public function setupStorage() {
-		// If encryption is disabled and there are no loaded modules it makes no sense to load the wrapper
-		if (!empty($this->encryptionModules) || $this->isEnabled()) {
-			$encryptionWrapper = new EncryptionWrapper($this->arrayCache, $this, $this->logger);
-			Filesystem::addStorageWrapper('oc_encryption', array($encryptionWrapper, 'wrapStorage'), 2);
-		}
-	}
-
-
-	/**
-	 * check if key storage is ready
-	 *
-	 * @return bool
-	 */
-	protected function isKeyStorageReady() {
-
-		$rootDir = $this->util->getKeyStorageRoot();
-
-		// the default root is always valid
-		if ($rootDir === '') {
-			return true;
-		}
-
-		// check if key storage is mounted correctly
-		if ($this->rootView->file_exists($rootDir . '/' . Storage::KEY_STORAGE_MARKER)) {
-			return true;
-		}
-
-		return false;
-	}
+    /** @var array */
+    protected $encryptionModules;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var ILogger */
+    protected $logger;
+
+    /** @var Il10n */
+    protected $l;
+
+    /** @var View  */
+    protected $rootView;
+
+    /** @var Util  */
+    protected $util;
+
+    /** @var ArrayCache  */
+    protected $arrayCache;
+
+    /**
+     * @param IConfig $config
+     * @param ILogger $logger
+     * @param IL10N $l10n
+     * @param View $rootView
+     * @param Util $util
+     * @param ArrayCache $arrayCache
+     */
+    public function __construct(IConfig $config, ILogger $logger, IL10N $l10n, View $rootView, Util $util, ArrayCache $arrayCache) {
+        $this->encryptionModules = array();
+        $this->config = $config;
+        $this->logger = $logger;
+        $this->l = $l10n;
+        $this->rootView = $rootView;
+        $this->util = $util;
+        $this->arrayCache = $arrayCache;
+    }
+
+    /**
+     * Check if encryption is enabled
+     *
+     * @return bool true if enabled, false if not
+     */
+    public function isEnabled() {
+
+        $installed = $this->config->getSystemValue('installed', false);
+        if (!$installed) {
+            return false;
+        }
+
+        $enabled = $this->config->getAppValue('core', 'encryption_enabled', 'no');
+        return $enabled === 'yes';
+    }
+
+    /**
+     * check if new encryption is ready
+     *
+     * @return bool
+     * @throws ServiceUnavailableException
+     */
+    public function isReady() {
+
+        if ($this->isKeyStorageReady() === false) {
+            throw new ServiceUnavailableException('Key Storage is not ready');
+        }
+
+        return true;
+    }
+
+    /**
+     * @param string $user
+     */
+    public function isReadyForUser($user) {
+        if (!$this->isReady()) {
+            return false;
+        }
+
+        foreach ($this->getEncryptionModules() as $module) {
+            /** @var IEncryptionModule $m */
+            $m = call_user_func($module['callback']);
+            if (!$m->isReadyForUser($user)) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+        /**
+         * Registers an callback function which must return an encryption module instance
+         *
+         * @param string $id
+         * @param string $displayName
+         * @param callable $callback
+         * @throws Exceptions\ModuleAlreadyExistsException
+         */
+    public function registerEncryptionModule($id, $displayName, callable $callback) {
+
+        if (isset($this->encryptionModules[$id])) {
+            throw new Exceptions\ModuleAlreadyExistsException($id, $displayName);
+        }
+
+        $this->encryptionModules[$id] = [
+            'id' => $id,
+            'displayName' => $displayName,
+            'callback' => $callback,
+        ];
+
+        $defaultEncryptionModuleId = $this->getDefaultEncryptionModuleId();
+
+        if (empty($defaultEncryptionModuleId)) {
+            $this->setDefaultEncryptionModule($id);
+        }
+    }
+
+    /**
+     * Unregisters an encryption module
+     *
+     * @param string $moduleId
+     */
+    public function unregisterEncryptionModule($moduleId) {
+        unset($this->encryptionModules[$moduleId]);
+    }
+
+    /**
+     * get a list of all encryption modules
+     *
+     * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]]
+     */
+    public function getEncryptionModules() {
+        return $this->encryptionModules;
+    }
+
+    /**
+     * get a specific encryption module
+     *
+     * @param string $moduleId
+     * @return IEncryptionModule
+     * @throws Exceptions\ModuleDoesNotExistsException
+     */
+    public function getEncryptionModule($moduleId = '') {
+        if (!empty($moduleId)) {
+            if (isset($this->encryptionModules[$moduleId])) {
+                return call_user_func($this->encryptionModules[$moduleId]['callback']);
+            } else {
+                $message = "Module with ID: $moduleId does not exist.";
+                $hint = $this->l->t('Module with ID: %s does not exist. Please enable it in your apps settings or contact your administrator.', [$moduleId]);
+                throw new Exceptions\ModuleDoesNotExistsException($message, $hint);
+            }
+        } else {
+            return $this->getDefaultEncryptionModule();
+        }
+    }
+
+    /**
+     * get default encryption module
+     *
+     * @return \OCP\Encryption\IEncryptionModule
+     * @throws Exceptions\ModuleDoesNotExistsException
+     */
+    protected function getDefaultEncryptionModule() {
+        $defaultModuleId = $this->getDefaultEncryptionModuleId();
+        if (!empty($defaultModuleId)) {
+            if (isset($this->encryptionModules[$defaultModuleId])) {
+                return call_user_func($this->encryptionModules[$defaultModuleId]['callback']);
+            } else {
+                $message = 'Default encryption module not loaded';
+                throw new Exceptions\ModuleDoesNotExistsException($message);
+            }
+        } else {
+            $message = 'No default encryption module defined';
+            throw new Exceptions\ModuleDoesNotExistsException($message);
+        }
+
+    }
+
+    /**
+     * set default encryption module Id
+     *
+     * @param string $moduleId
+     * @return bool
+     */
+    public function setDefaultEncryptionModule($moduleId) {
+        try {
+            $this->getEncryptionModule($moduleId);
+        } catch (\Exception $e) {
+            return false;
+        }
+
+        $this->config->setAppValue('core', 'default_encryption_module', $moduleId);
+        return true;
+    }
+
+    /**
+     * get default encryption module Id
+     *
+     * @return string
+     */
+    public function getDefaultEncryptionModuleId() {
+        return $this->config->getAppValue('core', 'default_encryption_module');
+    }
+
+    /**
+     * Add storage wrapper
+     */
+    public function setupStorage() {
+        // If encryption is disabled and there are no loaded modules it makes no sense to load the wrapper
+        if (!empty($this->encryptionModules) || $this->isEnabled()) {
+            $encryptionWrapper = new EncryptionWrapper($this->arrayCache, $this, $this->logger);
+            Filesystem::addStorageWrapper('oc_encryption', array($encryptionWrapper, 'wrapStorage'), 2);
+        }
+    }
+
+
+    /**
+     * check if key storage is ready
+     *
+     * @return bool
+     */
+    protected function isKeyStorageReady() {
+
+        $rootDir = $this->util->getKeyStorageRoot();
+
+        // the default root is always valid
+        if ($rootDir === '') {
+            return true;
+        }
+
+        // check if key storage is mounted correctly
+        if ($this->rootView->file_exists($rootDir . '/' . Storage::KEY_STORAGE_MARKER)) {
+            return true;
+        }
+
+        return false;
+    }
 
 
 }

lib/private/Encryption/HookManager.php

Indentation +41 added lines, -41 removed lines

@@ -27,50 +27,50 @@
 use OC\Files\View;
 
 class HookManager {
-	/**
-	 * @var Update
-	 */
-	private static $updater;
+    /**
+     * @var Update
+     */
+    private static $updater;
 
-	public static function postShared($params) {
-		self::getUpdate()->postShared($params);
-	}
-	public static function postUnshared($params) {
-		self::getUpdate()->postUnshared($params);
-	}
+    public static function postShared($params) {
+        self::getUpdate()->postShared($params);
+    }
+    public static function postUnshared($params) {
+        self::getUpdate()->postUnshared($params);
+    }
 
-	public static function postRename($params) {
-		self::getUpdate()->postRename($params);
-	}
+    public static function postRename($params) {
+        self::getUpdate()->postRename($params);
+    }
 
-	public static function postRestore($params) {
-		self::getUpdate()->postRestore($params);
-	}
+    public static function postRestore($params) {
+        self::getUpdate()->postRestore($params);
+    }
 
-	/**
-	 * @return Update
-	 */
-	private static function getUpdate() {
-		if (is_null(self::$updater)) {
-			$user = \OC::$server->getUserSession()->getUser();
-			$uid = '';
-			if ($user) {
-				$uid = $user->getUID();
-			}
-			self::$updater = new Update(
-				new View(),
-				new Util(
-					new View(),
-					\OC::$server->getUserManager(),
-					\OC::$server->getGroupManager(),
-					\OC::$server->getConfig()),
-				Filesystem::getMountManager(),
-				\OC::$server->getEncryptionManager(),
-				\OC::$server->getEncryptionFilesHelper(),
-				$uid
-			);
-		}
+    /**
+     * @return Update
+     */
+    private static function getUpdate() {
+        if (is_null(self::$updater)) {
+            $user = \OC::$server->getUserSession()->getUser();
+            $uid = '';
+            if ($user) {
+                $uid = $user->getUID();
+            }
+            self::$updater = new Update(
+                new View(),
+                new Util(
+                    new View(),
+                    \OC::$server->getUserManager(),
+                    \OC::$server->getGroupManager(),
+                    \OC::$server->getConfig()),
+                Filesystem::getMountManager(),
+                \OC::$server->getEncryptionManager(),
+                \OC::$server->getEncryptionFilesHelper(),
+                $uid
+            );
+        }
 
-		return self::$updater;
-	}
+        return self::$updater;
+    }
 }

lib/private/NaturalSort.php

Spacing +2 added lines, -2 removed lines

@@ -117,8 +117,8 @@
 			if ($aChunk !== $bChunk) {
 				// test first character (character comparison, not number comparison)
 				if ($aChunk[0] >= '0' && $aChunk[0] <= '9' && $bChunk[0] >= '0' && $bChunk[0] <= '9') {
-					$aNum = (int)$aChunk;
-					$bNum = (int)$bChunk;
+					$aNum = (int) $aChunk;
+					$bNum = (int) $bChunk;
 					return $aNum - $bNum;
 				}
 				return self::getCollator()->compare($aChunk, $bChunk);

Braces +1 added lines, -2 removed lines

@@ -88,8 +88,7 @@
 			// German umlauts, so using en_US instead
 			if (class_exists('Collator')) {
 				$this->collator = new \Collator('en_US');
-			}
-			else {
+			} else {
 				$this->collator = new \OC\NaturalSort_DefaultCollator();
 			}
 		}

Indentation +102 added lines, -102 removed lines

@@ -30,113 +30,113 @@
 use OCP\ILogger;
 
 class NaturalSort {
-	private static $instance;
-	private $collator;
-	private $cache = array();
+    private static $instance;
+    private $collator;
+    private $cache = array();
 
-	/**
-	 * Instantiate a new \OC\NaturalSort instance.
-	 * @param object $injectedCollator
-	 */
-	public function __construct($injectedCollator = null) {
-		// inject an instance of \Collator('en_US') to force using the php5-intl Collator
-		// or inject an instance of \OC\NaturalSort_DefaultCollator to force using Owncloud's default collator
-		if (isset($injectedCollator)) {
-			$this->collator = $injectedCollator;
-			\OCP\Util::writeLog('core', 'forced use of '.get_class($injectedCollator), ILogger::DEBUG);
-		}
-	}
+    /**
+     * Instantiate a new \OC\NaturalSort instance.
+     * @param object $injectedCollator
+     */
+    public function __construct($injectedCollator = null) {
+        // inject an instance of \Collator('en_US') to force using the php5-intl Collator
+        // or inject an instance of \OC\NaturalSort_DefaultCollator to force using Owncloud's default collator
+        if (isset($injectedCollator)) {
+            $this->collator = $injectedCollator;
+            \OCP\Util::writeLog('core', 'forced use of '.get_class($injectedCollator), ILogger::DEBUG);
+        }
+    }
 
-	/**
-	 * Split the given string in chunks of numbers and strings
-	 * @param string $t string
-	 * @return array of strings and number chunks
-	 */
-	private function naturalSortChunkify($t) {
-		// Adapted and ported to PHP from
-		// http://my.opera.com/GreyWyvern/blog/show.dml/1671288
-		if (isset($this->cache[$t])) {
-			return $this->cache[$t];
-		}
-		$tz = array();
-		$x = 0;
-		$y = -1;
-		$n = null;
+    /**
+     * Split the given string in chunks of numbers and strings
+     * @param string $t string
+     * @return array of strings and number chunks
+     */
+    private function naturalSortChunkify($t) {
+        // Adapted and ported to PHP from
+        // http://my.opera.com/GreyWyvern/blog/show.dml/1671288
+        if (isset($this->cache[$t])) {
+            return $this->cache[$t];
+        }
+        $tz = array();
+        $x = 0;
+        $y = -1;
+        $n = null;
 
-		while (isset($t[$x])) {
-			$c = $t[$x];
-			// only include the dot in strings
-			$m = ((!$n && $c === '.') || ($c >= '0' && $c <= '9'));
-			if ($m !== $n) {
-				// next chunk
-				$y++;
-				$tz[$y] = '';
-				$n = $m;
-			}
-			$tz[$y] .= $c;
-			$x++;
-		}
-		$this->cache[$t] = $tz;
-		return $tz;
-	}
+        while (isset($t[$x])) {
+            $c = $t[$x];
+            // only include the dot in strings
+            $m = ((!$n && $c === '.') || ($c >= '0' && $c <= '9'));
+            if ($m !== $n) {
+                // next chunk
+                $y++;
+                $tz[$y] = '';
+                $n = $m;
+            }
+            $tz[$y] .= $c;
+            $x++;
+        }
+        $this->cache[$t] = $tz;
+        return $tz;
+    }
 
-	/**
-	 * Returns the string collator
-	 * @return \Collator string collator
-	 */
-	private function getCollator() {
-		if (!isset($this->collator)) {
-			// looks like the default is en_US_POSIX which yields wrong sorting with
-			// German umlauts, so using en_US instead
-			if (class_exists('Collator')) {
-				$this->collator = new \Collator('en_US');
-			}
-			else {
-				$this->collator = new \OC\NaturalSort_DefaultCollator();
-			}
-		}
-		return $this->collator;
-	}
+    /**
+     * Returns the string collator
+     * @return \Collator string collator
+     */
+    private function getCollator() {
+        if (!isset($this->collator)) {
+            // looks like the default is en_US_POSIX which yields wrong sorting with
+            // German umlauts, so using en_US instead
+            if (class_exists('Collator')) {
+                $this->collator = new \Collator('en_US');
+            }
+            else {
+                $this->collator = new \OC\NaturalSort_DefaultCollator();
+            }
+        }
+        return $this->collator;
+    }
 
-	/**
-	 * Compare two strings to provide a natural sort
-	 * @param string $a first string to compare
-	 * @param string $b second string to compare
-	 * @return int -1 if $b comes before $a, 1 if $a comes before $b
-	 * or 0 if the strings are identical
-	 */
-	public function compare($a, $b) {
-		// Needed because PHP doesn't sort correctly when numbers are enclosed in
-		// parenthesis, even with NUMERIC_COLLATION enabled.
-		// For example it gave ["test (2).txt", "test.txt"]
-		// instead of ["test.txt", "test (2).txt"]
-		$aa = self::naturalSortChunkify($a);
-		$bb = self::naturalSortChunkify($b);
+    /**
+     * Compare two strings to provide a natural sort
+     * @param string $a first string to compare
+     * @param string $b second string to compare
+     * @return int -1 if $b comes before $a, 1 if $a comes before $b
+     * or 0 if the strings are identical
+     */
+    public function compare($a, $b) {
+        // Needed because PHP doesn't sort correctly when numbers are enclosed in
+        // parenthesis, even with NUMERIC_COLLATION enabled.
+        // For example it gave ["test (2).txt", "test.txt"]
+        // instead of ["test.txt", "test (2).txt"]
+        $aa = self::naturalSortChunkify($a);
+        $bb = self::naturalSortChunkify($b);
 
-		for ($x = 0; isset($aa[$x]) && isset($bb[$x]); $x++) {
-			$aChunk = $aa[$x];
-			$bChunk = $bb[$x];
-			if ($aChunk !== $bChunk) {
-				// test first character (character comparison, not number comparison)
-				if ($aChunk[0] >= '0' && $aChunk[0] <= '9' && $bChunk[0] >= '0' && $bChunk[0] <= '9') {
-					$aNum = (int)$aChunk;
-					$bNum = (int)$bChunk;
-					return $aNum - $bNum;
-				}
-				return self::getCollator()->compare($aChunk, $bChunk);
-			}
-		}
-		return count($aa) - count($bb);
-	}
+        for ($x = 0; isset($aa[$x]) && isset($bb[$x]); $x++) {
+            $aChunk = $aa[$x];
+            $bChunk = $bb[$x];
+            if ($aChunk !== $bChunk) {
+                // test first character (character comparison, not number comparison)
+                if ($aChunk[0] >= '0' && $aChunk[0] <= '9' && $bChunk[0] >= '0' && $bChunk[0] <= '9') {
+                    $aNum = (int)$aChunk;
+                    $bNum = (int)$bChunk;
+                    return $aNum - $bNum;
+                }
+                return self::getCollator()->compare($aChunk, $bChunk);
+            }
+        }
+        return count($aa) - count($bb);
+    }
 
-	/**
-	 * Returns a singleton
-	 * @return \OC\NaturalSort instance
-	 */
-	public static function getInstance() {
-		if (!isset(self::$instance)) {
-			self::$instance = new \OC\NaturalSort();
-		}
-		return self::$instance;
-	}
+    /**
+     * Returns a singleton
+     * @return \OC\NaturalSort instance
+     */
+    public static function getInstance() {
+        if (!isset(self::$instance)) {
+            self::$instance = new \OC\NaturalSort();
+        }
+        return self::$instance;
+    }
 }

lib/private/Group/Database.php

Braces +1 added lines, -1 removed lines

@@ -168,7 +168,7 @@
 				->setValue('gid', $qb->createNamedParameter($gid))
 				->execute();
 			return true;
-		}else{
+		} else{
 			return false;
 		}
 	}

Spacing +12 added lines, -12 removed lines

@@ -111,7 +111,7 @@ 
 				->setValue('gid', $builder->createNamedParameter($gid))
 				->setValue('displayname', $builder->createNamedParameter($gid))
 				->execute();
-		} catch(UniqueConstraintViolationException $e) {
+		} catch (UniqueConstraintViolationException $e) {
 			$result = 0;
 		}
 
@@ -163,7 +163,7 @@ 
 	 *
 	 * Checks whether the user is member of a group or not.
 	 */
-	public function inGroup( $uid, $gid ) {
+	public function inGroup($uid, $gid) {
 		$this->fixDI();
 
 		// check
@@ -192,14 +192,14 @@ 
 		$this->fixDI();
 
 		// No duplicate entries!
-		if( !$this->inGroup( $uid, $gid )) {
+		if (!$this->inGroup($uid, $gid)) {
 			$qb = $this->dbConn->getQueryBuilder();
 			$qb->insert('group_user')
 				->setValue('uid', $qb->createNamedParameter($uid))
 				->setValue('gid', $qb->createNamedParameter($gid))
 				->execute();
 			return true;
-		}else{
+		} else {
 			return false;
 		}
 	}
@@ -232,7 +232,7 @@ 
 	 * This function fetches all groups a user belongs to. It does not check
 	 * if the user exists at all.
 	 */
-	public function getUserGroups( $uid ) {
+	public function getUserGroups($uid) {
 		//guests has empty or null $uid
 		if ($uid === null || $uid === '') {
 			return [];
@@ -248,7 +248,7 @@ 
 			->execute();
 
 		$groups = [];
-		while( $row = $cursor->fetch()) {
+		while ($row = $cursor->fetch()) {
 			$groups[] = $row['gid'];
 			$this->groupCache[$row['gid']] = $row['gid'];
 		}
@@ -276,7 +276,7 @@ 
 
 		if ($search !== '') {
 			$query->where($query->expr()->iLike('gid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
+				'%'.$this->dbConn->escapeLikeParameter($search).'%'
 			)));
 		}
 
@@ -340,7 +340,7 @@ 
 
 		if ($search !== '') {
 			$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
+				'%'.$this->dbConn->escapeLikeParameter($search).'%'
 			)));
 		}
 
@@ -378,7 +378,7 @@ 
 
 		if ($search !== '') {
 			$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
+				'%'.$this->dbConn->escapeLikeParameter($search).'%'
 			)));
 		}
 
@@ -387,7 +387,7 @@ 
 		$result->closeCursor();
 
 		if ($count !== false) {
-			$count = (int)$count;
+			$count = (int) $count;
 		} else {
 			$count = 0;
 		}
@@ -405,7 +405,7 @@ 
 		$this->fixDI();
 
 		$query = $this->dbConn->getQueryBuilder();
-		$query->select($query->createFunction('COUNT(DISTINCT ' . $query->getColumnName('uid') . ')'))
+		$query->select($query->createFunction('COUNT(DISTINCT '.$query->getColumnName('uid').')'))
 			->from('preferences', 'p')
 			->innerJoin('p', 'group_user', 'g', $query->expr()->eq('p.userid', 'g.uid'))
 			->where($query->expr()->eq('appid', $query->createNamedParameter('core')))
@@ -418,7 +418,7 @@ 
 		$result->closeCursor();
 
 		if ($count !== false) {
-			$count = (int)$count;
+			$count = (int) $count;
 		} else {
 			$count = 0;
 		}

Indentation +412 added lines, -412 removed lines

@@ -60,417 +60,417 @@
  * Class for group management in a SQL Database (e.g. MySQL, SQLite)
  */
 class Database extends ABackend
-	implements IAddToGroupBackend,
-	           ICountDisabledInGroup,
-	           ICountUsersBackend,
-	           ICreateGroupBackend,
-	           IDeleteGroupBackend,
-	           IGetDisplayNameBackend,
-	           IGroupDetailsBackend,
-	           IRemoveFromGroupBackend,
-	           ISetDisplayNameBackend {
-
-	/** @var string[] */
-	private $groupCache = [];
-
-	/** @var IDBConnection */
-	private $dbConn;
-
-	/**
-	 * \OC\Group\Database constructor.
-	 *
-	 * @param IDBConnection|null $dbConn
-	 */
-	public function __construct(IDBConnection $dbConn = null) {
-		$this->dbConn = $dbConn;
-	}
-
-	/**
-	 * FIXME: This function should not be required!
-	 */
-	private function fixDI() {
-		if ($this->dbConn === null) {
-			$this->dbConn = \OC::$server->getDatabaseConnection();
-		}
-	}
-
-	/**
-	 * Try to create a new group
-	 * @param string $gid The name of the group to create
-	 * @return bool
-	 *
-	 * Tries to create a new group. If the group name already exists, false will
-	 * be returned.
-	 */
-	public function createGroup(string $gid): bool {
-		$this->fixDI();
-
-		try {
-			// Add group
-			$builder = $this->dbConn->getQueryBuilder();
-			$result = $builder->insert('groups')
-				->setValue('gid', $builder->createNamedParameter($gid))
-				->setValue('displayname', $builder->createNamedParameter($gid))
-				->execute();
-		} catch(UniqueConstraintViolationException $e) {
-			$result = 0;
-		}
-
-		// Add to cache
-		$this->groupCache[$gid] = $gid;
-
-		return $result === 1;
-	}
-
-	/**
-	 * delete a group
-	 * @param string $gid gid of the group to delete
-	 * @return bool
-	 *
-	 * Deletes a group and removes it from the group_user-table
-	 */
-	public function deleteGroup(string $gid): bool {
-		$this->fixDI();
-
-		// Delete the group
-		$qb = $this->dbConn->getQueryBuilder();
-		$qb->delete('groups')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->execute();
-
-		// Delete the group-user relation
-		$qb = $this->dbConn->getQueryBuilder();
-		$qb->delete('group_user')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->execute();
-
-		// Delete the group-groupadmin relation
-		$qb = $this->dbConn->getQueryBuilder();
-		$qb->delete('group_admin')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->execute();
-
-		// Delete from cache
-		unset($this->groupCache[$gid]);
-
-		return true;
-	}
-
-	/**
-	 * is user in group?
-	 * @param string $uid uid of the user
-	 * @param string $gid gid of the group
-	 * @return bool
-	 *
-	 * Checks whether the user is member of a group or not.
-	 */
-	public function inGroup( $uid, $gid ) {
-		$this->fixDI();
-
-		// check
-		$qb = $this->dbConn->getQueryBuilder();
-		$cursor = $qb->select('uid')
-			->from('group_user')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
-			->execute();
-
-		$result = $cursor->fetch();
-		$cursor->closeCursor();
-
-		return $result ? true : false;
-	}
-
-	/**
-	 * Add a user to a group
-	 * @param string $uid Name of the user to add to group
-	 * @param string $gid Name of the group in which add the user
-	 * @return bool
-	 *
-	 * Adds a user to a group.
-	 */
-	public function addToGroup(string $uid, string $gid): bool {
-		$this->fixDI();
-
-		// No duplicate entries!
-		if( !$this->inGroup( $uid, $gid )) {
-			$qb = $this->dbConn->getQueryBuilder();
-			$qb->insert('group_user')
-				->setValue('uid', $qb->createNamedParameter($uid))
-				->setValue('gid', $qb->createNamedParameter($gid))
-				->execute();
-			return true;
-		}else{
-			return false;
-		}
-	}
-
-	/**
-	 * Removes a user from a group
-	 * @param string $uid Name of the user to remove from group
-	 * @param string $gid Name of the group from which remove the user
-	 * @return bool
-	 *
-	 * removes the user from a group.
-	 */
-	public function removeFromGroup(string $uid, string $gid): bool {
-		$this->fixDI();
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$qb->delete('group_user')
-			->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
-			->andWhere($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->execute();
-
-		return true;
-	}
-
-	/**
-	 * Get all groups a user belongs to
-	 * @param string $uid Name of the user
-	 * @return array an array of group names
-	 *
-	 * This function fetches all groups a user belongs to. It does not check
-	 * if the user exists at all.
-	 */
-	public function getUserGroups( $uid ) {
-		//guests has empty or null $uid
-		if ($uid === null || $uid === '') {
-			return [];
-		}
-
-		$this->fixDI();
-
-		// No magic!
-		$qb = $this->dbConn->getQueryBuilder();
-		$cursor = $qb->select('gid')
-			->from('group_user')
-			->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
-			->execute();
-
-		$groups = [];
-		while( $row = $cursor->fetch()) {
-			$groups[] = $row['gid'];
-			$this->groupCache[$row['gid']] = $row['gid'];
-		}
-		$cursor->closeCursor();
-
-		return $groups;
-	}
-
-	/**
-	 * get a list of all groups
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array an array of group names
-	 *
-	 * Returns a list with all groups
-	 */
-	public function getGroups($search = '', $limit = null, $offset = null) {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select('gid')
-			->from('groups')
-			->orderBy('gid', 'ASC');
-
-		if ($search !== '') {
-			$query->where($query->expr()->iLike('gid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
-			)));
-		}
-
-		$query->setMaxResults($limit)
-			->setFirstResult($offset);
-		$result = $query->execute();
-
-		$groups = [];
-		while ($row = $result->fetch()) {
-			$groups[] = $row['gid'];
-		}
-		$result->closeCursor();
-
-		return $groups;
-	}
-
-	/**
-	 * check if a group exists
-	 * @param string $gid
-	 * @return bool
-	 */
-	public function groupExists($gid) {
-		$this->fixDI();
-
-		// Check cache first
-		if (isset($this->groupCache[$gid])) {
-			return true;
-		}
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$cursor = $qb->select('gid')
-			->from('groups')
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
-			->execute();
-		$result = $cursor->fetch();
-		$cursor->closeCursor();
-
-		if ($result !== false) {
-			$this->groupCache[$gid] = $gid;
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * get a list of all users in a group
-	 * @param string $gid
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array an array of user ids
-	 */
-	public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select('uid')
-			->from('group_user')
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)))
-			->orderBy('uid', 'ASC');
-
-		if ($search !== '') {
-			$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
-			)));
-		}
-
-		if ($limit !== -1) {
-			$query->setMaxResults($limit);
-		}
-		if ($offset !== 0) {
-			$query->setFirstResult($offset);
-		}
-
-		$result = $query->execute();
-
-		$users = [];
-		while ($row = $result->fetch()) {
-			$users[] = $row['uid'];
-		}
-		$result->closeCursor();
-
-		return $users;
-	}
-
-	/**
-	 * get the number of all users matching the search string in a group
-	 * @param string $gid
-	 * @param string $search
-	 * @return int
-	 */
-	public function countUsersInGroup(string $gid, string $search = ''): int {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select($query->func()->count('*', 'num_users'))
-			->from('group_user')
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
-
-		if ($search !== '') {
-			$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
-			)));
-		}
-
-		$result = $query->execute();
-		$count = $result->fetchColumn();
-		$result->closeCursor();
-
-		if ($count !== false) {
-			$count = (int)$count;
-		} else {
-			$count = 0;
-		}
-
-		return $count;
-	}
-
-	/**
-	 * get the number of disabled users in a group
-	 *
-	 * @param string $search
-	 *
-	 * @return int
-	 */
-	public function countDisabledInGroup(string $gid): int {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select($query->createFunction('COUNT(DISTINCT ' . $query->getColumnName('uid') . ')'))
-			->from('preferences', 'p')
-			->innerJoin('p', 'group_user', 'g', $query->expr()->eq('p.userid', 'g.uid'))
-			->where($query->expr()->eq('appid', $query->createNamedParameter('core')))
-			->andWhere($query->expr()->eq('configkey', $query->createNamedParameter('enabled')))
-			->andWhere($query->expr()->eq('configvalue', $query->createNamedParameter('false'), IQueryBuilder::PARAM_STR))
-			->andWhere($query->expr()->eq('gid', $query->createNamedParameter($gid), IQueryBuilder::PARAM_STR));
-
-		$result = $query->execute();
-		$count = $result->fetchColumn();
-		$result->closeCursor();
-
-		if ($count !== false) {
-			$count = (int)$count;
-		} else {
-			$count = 0;
-		}
-
-		return $count;
-	}
-
-	public function getDisplayName(string $gid): string {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select('displayname')
-			->from('groups')
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
-
-		$result = $query->execute();
-		$displayName = $result->fetchColumn();
-		$result->closeCursor();
-
-		return (string) $displayName;
-	}
-
-	public function getGroupDetails(string $gid): array {
-		$displayName = $this->getDisplayName($gid);
-		if ($displayName !== '') {
-			return ['displayName' => $displayName];
-		}
-
-		return [];
-	}
-
-	public function setDisplayName(string $gid, string $displayName): bool {
-		if (!$this->groupExists($gid)) {
-			return false;
-		}
-
-		$this->fixDI();
-
-		$displayName = trim($displayName);
-		if ($displayName === '') {
-			$displayName = $gid;
-		}
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->update('groups')
-			->set('displayname', $query->createNamedParameter($displayName))
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
-		$query->execute();
-
-		return true;
-	}
+    implements IAddToGroupBackend,
+                ICountDisabledInGroup,
+                ICountUsersBackend,
+                ICreateGroupBackend,
+                IDeleteGroupBackend,
+                IGetDisplayNameBackend,
+                IGroupDetailsBackend,
+                IRemoveFromGroupBackend,
+                ISetDisplayNameBackend {
+
+    /** @var string[] */
+    private $groupCache = [];
+
+    /** @var IDBConnection */
+    private $dbConn;
+
+    /**
+     * \OC\Group\Database constructor.
+     *
+     * @param IDBConnection|null $dbConn
+     */
+    public function __construct(IDBConnection $dbConn = null) {
+        $this->dbConn = $dbConn;
+    }
+
+    /**
+     * FIXME: This function should not be required!
+     */
+    private function fixDI() {
+        if ($this->dbConn === null) {
+            $this->dbConn = \OC::$server->getDatabaseConnection();
+        }
+    }
+
+    /**
+     * Try to create a new group
+     * @param string $gid The name of the group to create
+     * @return bool
+     *
+     * Tries to create a new group. If the group name already exists, false will
+     * be returned.
+     */
+    public function createGroup(string $gid): bool {
+        $this->fixDI();
+
+        try {
+            // Add group
+            $builder = $this->dbConn->getQueryBuilder();
+            $result = $builder->insert('groups')
+                ->setValue('gid', $builder->createNamedParameter($gid))
+                ->setValue('displayname', $builder->createNamedParameter($gid))
+                ->execute();
+        } catch(UniqueConstraintViolationException $e) {
+            $result = 0;
+        }
+
+        // Add to cache
+        $this->groupCache[$gid] = $gid;
+
+        return $result === 1;
+    }
+
+    /**
+     * delete a group
+     * @param string $gid gid of the group to delete
+     * @return bool
+     *
+     * Deletes a group and removes it from the group_user-table
+     */
+    public function deleteGroup(string $gid): bool {
+        $this->fixDI();
+
+        // Delete the group
+        $qb = $this->dbConn->getQueryBuilder();
+        $qb->delete('groups')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->execute();
+
+        // Delete the group-user relation
+        $qb = $this->dbConn->getQueryBuilder();
+        $qb->delete('group_user')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->execute();
+
+        // Delete the group-groupadmin relation
+        $qb = $this->dbConn->getQueryBuilder();
+        $qb->delete('group_admin')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->execute();
+
+        // Delete from cache
+        unset($this->groupCache[$gid]);
+
+        return true;
+    }
+
+    /**
+     * is user in group?
+     * @param string $uid uid of the user
+     * @param string $gid gid of the group
+     * @return bool
+     *
+     * Checks whether the user is member of a group or not.
+     */
+    public function inGroup( $uid, $gid ) {
+        $this->fixDI();
+
+        // check
+        $qb = $this->dbConn->getQueryBuilder();
+        $cursor = $qb->select('uid')
+            ->from('group_user')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
+            ->execute();
+
+        $result = $cursor->fetch();
+        $cursor->closeCursor();
+
+        return $result ? true : false;
+    }
+
+    /**
+     * Add a user to a group
+     * @param string $uid Name of the user to add to group
+     * @param string $gid Name of the group in which add the user
+     * @return bool
+     *
+     * Adds a user to a group.
+     */
+    public function addToGroup(string $uid, string $gid): bool {
+        $this->fixDI();
+
+        // No duplicate entries!
+        if( !$this->inGroup( $uid, $gid )) {
+            $qb = $this->dbConn->getQueryBuilder();
+            $qb->insert('group_user')
+                ->setValue('uid', $qb->createNamedParameter($uid))
+                ->setValue('gid', $qb->createNamedParameter($gid))
+                ->execute();
+            return true;
+        }else{
+            return false;
+        }
+    }
+
+    /**
+     * Removes a user from a group
+     * @param string $uid Name of the user to remove from group
+     * @param string $gid Name of the group from which remove the user
+     * @return bool
+     *
+     * removes the user from a group.
+     */
+    public function removeFromGroup(string $uid, string $gid): bool {
+        $this->fixDI();
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $qb->delete('group_user')
+            ->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
+            ->andWhere($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->execute();
+
+        return true;
+    }
+
+    /**
+     * Get all groups a user belongs to
+     * @param string $uid Name of the user
+     * @return array an array of group names
+     *
+     * This function fetches all groups a user belongs to. It does not check
+     * if the user exists at all.
+     */
+    public function getUserGroups( $uid ) {
+        //guests has empty or null $uid
+        if ($uid === null || $uid === '') {
+            return [];
+        }
+
+        $this->fixDI();
+
+        // No magic!
+        $qb = $this->dbConn->getQueryBuilder();
+        $cursor = $qb->select('gid')
+            ->from('group_user')
+            ->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
+            ->execute();
+
+        $groups = [];
+        while( $row = $cursor->fetch()) {
+            $groups[] = $row['gid'];
+            $this->groupCache[$row['gid']] = $row['gid'];
+        }
+        $cursor->closeCursor();
+
+        return $groups;
+    }
+
+    /**
+     * get a list of all groups
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array an array of group names
+     *
+     * Returns a list with all groups
+     */
+    public function getGroups($search = '', $limit = null, $offset = null) {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select('gid')
+            ->from('groups')
+            ->orderBy('gid', 'ASC');
+
+        if ($search !== '') {
+            $query->where($query->expr()->iLike('gid', $query->createNamedParameter(
+                '%' . $this->dbConn->escapeLikeParameter($search) . '%'
+            )));
+        }
+
+        $query->setMaxResults($limit)
+            ->setFirstResult($offset);
+        $result = $query->execute();
+
+        $groups = [];
+        while ($row = $result->fetch()) {
+            $groups[] = $row['gid'];
+        }
+        $result->closeCursor();
+
+        return $groups;
+    }
+
+    /**
+     * check if a group exists
+     * @param string $gid
+     * @return bool
+     */
+    public function groupExists($gid) {
+        $this->fixDI();
+
+        // Check cache first
+        if (isset($this->groupCache[$gid])) {
+            return true;
+        }
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $cursor = $qb->select('gid')
+            ->from('groups')
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
+            ->execute();
+        $result = $cursor->fetch();
+        $cursor->closeCursor();
+
+        if ($result !== false) {
+            $this->groupCache[$gid] = $gid;
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * get a list of all users in a group
+     * @param string $gid
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array an array of user ids
+     */
+    public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select('uid')
+            ->from('group_user')
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)))
+            ->orderBy('uid', 'ASC');
+
+        if ($search !== '') {
+            $query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
+                '%' . $this->dbConn->escapeLikeParameter($search) . '%'
+            )));
+        }
+
+        if ($limit !== -1) {
+            $query->setMaxResults($limit);
+        }
+        if ($offset !== 0) {
+            $query->setFirstResult($offset);
+        }
+
+        $result = $query->execute();
+
+        $users = [];
+        while ($row = $result->fetch()) {
+            $users[] = $row['uid'];
+        }
+        $result->closeCursor();
+
+        return $users;
+    }
+
+    /**
+     * get the number of all users matching the search string in a group
+     * @param string $gid
+     * @param string $search
+     * @return int
+     */
+    public function countUsersInGroup(string $gid, string $search = ''): int {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select($query->func()->count('*', 'num_users'))
+            ->from('group_user')
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
+
+        if ($search !== '') {
+            $query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
+                '%' . $this->dbConn->escapeLikeParameter($search) . '%'
+            )));
+        }
+
+        $result = $query->execute();
+        $count = $result->fetchColumn();
+        $result->closeCursor();
+
+        if ($count !== false) {
+            $count = (int)$count;
+        } else {
+            $count = 0;
+        }
+
+        return $count;
+    }
+
+    /**
+     * get the number of disabled users in a group
+     *
+     * @param string $search
+     *
+     * @return int
+     */
+    public function countDisabledInGroup(string $gid): int {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select($query->createFunction('COUNT(DISTINCT ' . $query->getColumnName('uid') . ')'))
+            ->from('preferences', 'p')
+            ->innerJoin('p', 'group_user', 'g', $query->expr()->eq('p.userid', 'g.uid'))
+            ->where($query->expr()->eq('appid', $query->createNamedParameter('core')))
+            ->andWhere($query->expr()->eq('configkey', $query->createNamedParameter('enabled')))
+            ->andWhere($query->expr()->eq('configvalue', $query->createNamedParameter('false'), IQueryBuilder::PARAM_STR))
+            ->andWhere($query->expr()->eq('gid', $query->createNamedParameter($gid), IQueryBuilder::PARAM_STR));
+
+        $result = $query->execute();
+        $count = $result->fetchColumn();
+        $result->closeCursor();
+
+        if ($count !== false) {
+            $count = (int)$count;
+        } else {
+            $count = 0;
+        }
+
+        return $count;
+    }
+
+    public function getDisplayName(string $gid): string {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select('displayname')
+            ->from('groups')
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
+
+        $result = $query->execute();
+        $displayName = $result->fetchColumn();
+        $result->closeCursor();
+
+        return (string) $displayName;
+    }
+
+    public function getGroupDetails(string $gid): array {
+        $displayName = $this->getDisplayName($gid);
+        if ($displayName !== '') {
+            return ['displayName' => $displayName];
+        }
+
+        return [];
+    }
+
+    public function setDisplayName(string $gid, string $displayName): bool {
+        if (!$this->groupExists($gid)) {
+            return false;
+        }
+
+        $this->fixDI();
+
+        $displayName = trim($displayName);
+        if ($displayName === '') {
+            $displayName = $gid;
+        }
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->update('groups')
+            ->set('displayname', $query->createNamedParameter($displayName))
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
+        $query->execute();
+
+        return true;
+    }
 
 }

lib/private/Group/Backend.php

Spacing +3 added lines, -3 removed lines

@@ -49,8 +49,8 @@ 
 	*/
 	public function getSupportedActions() {
 		$actions = 0;
-		foreach($this->possibleActions AS $action => $methodName) {
-			if(method_exists($this, $methodName)) {
+		foreach ($this->possibleActions AS $action => $methodName) {
+			if (method_exists($this, $methodName)) {
 				$actions |= $action;
 			}
 		}
@@ -67,7 +67,7 @@ 
 	* compared with \OC\Group\Backend::CREATE_GROUP etc.
 	*/
 	public function implementsActions($actions) {
-		return (bool)($this->getSupportedActions() & $actions);
+		return (bool) ($this->getSupportedActions() & $actions);
 	}
 
 	/**

Indentation +93 added lines, -93 removed lines

@@ -26,107 +26,107 @@
  * Abstract base class for user management
  */
 abstract class Backend implements \OCP\GroupInterface {
-	/**
-	 * error code for functions not provided by the group backend
-	 */
-	const NOT_IMPLEMENTED = -501;
+    /**
+     * error code for functions not provided by the group backend
+     */
+    const NOT_IMPLEMENTED = -501;
 
-	protected $possibleActions = [
-		self::CREATE_GROUP => 'createGroup',
-		self::DELETE_GROUP => 'deleteGroup',
-		self::ADD_TO_GROUP => 'addToGroup',
-		self::REMOVE_FROM_GOUP => 'removeFromGroup',
-		self::COUNT_USERS => 'countUsersInGroup',
-		self::GROUP_DETAILS => 'getGroupDetails',
-		self::IS_ADMIN => 'isAdmin',
-	];
+    protected $possibleActions = [
+        self::CREATE_GROUP => 'createGroup',
+        self::DELETE_GROUP => 'deleteGroup',
+        self::ADD_TO_GROUP => 'addToGroup',
+        self::REMOVE_FROM_GOUP => 'removeFromGroup',
+        self::COUNT_USERS => 'countUsersInGroup',
+        self::GROUP_DETAILS => 'getGroupDetails',
+        self::IS_ADMIN => 'isAdmin',
+    ];
 
-	/**
-	* Get all supported actions
-	* @return int bitwise-or'ed actions
-	*
-	* Returns the supported actions as int to be
-	* compared with \OC\Group\Backend::CREATE_GROUP etc.
-	*/
-	public function getSupportedActions() {
-		$actions = 0;
-		foreach($this->possibleActions AS $action => $methodName) {
-			if(method_exists($this, $methodName)) {
-				$actions |= $action;
-			}
-		}
+    /**
+     * Get all supported actions
+     * @return int bitwise-or'ed actions
+     *
+     * Returns the supported actions as int to be
+     * compared with \OC\Group\Backend::CREATE_GROUP etc.
+     */
+    public function getSupportedActions() {
+        $actions = 0;
+        foreach($this->possibleActions AS $action => $methodName) {
+            if(method_exists($this, $methodName)) {
+                $actions |= $action;
+            }
+        }
 
-		return $actions;
-	}
+        return $actions;
+    }
 
-	/**
-	* Check if backend implements actions
-	* @param int $actions bitwise-or'ed actions
-	* @return bool
-	*
-	* Returns the supported actions as int to be
-	* compared with \OC\Group\Backend::CREATE_GROUP etc.
-	*/
-	public function implementsActions($actions) {
-		return (bool)($this->getSupportedActions() & $actions);
-	}
+    /**
+     * Check if backend implements actions
+     * @param int $actions bitwise-or'ed actions
+     * @return bool
+     *
+     * Returns the supported actions as int to be
+     * compared with \OC\Group\Backend::CREATE_GROUP etc.
+     */
+    public function implementsActions($actions) {
+        return (bool)($this->getSupportedActions() & $actions);
+    }
 
-	/**
-	 * is user in group?
-	 * @param string $uid uid of the user
-	 * @param string $gid gid of the group
-	 * @return bool
-	 *
-	 * Checks whether the user is member of a group or not.
-	 */
-	public function inGroup($uid, $gid) {
-		return in_array($gid, $this->getUserGroups($uid));
-	}
+    /**
+     * is user in group?
+     * @param string $uid uid of the user
+     * @param string $gid gid of the group
+     * @return bool
+     *
+     * Checks whether the user is member of a group or not.
+     */
+    public function inGroup($uid, $gid) {
+        return in_array($gid, $this->getUserGroups($uid));
+    }
 
-	/**
-	 * Get all groups a user belongs to
-	 * @param string $uid Name of the user
-	 * @return array an array of group names
-	 *
-	 * This function fetches all groups a user belongs to. It does not check
-	 * if the user exists at all.
-	 */
-	public function getUserGroups($uid) {
-		return array();
-	}
+    /**
+     * Get all groups a user belongs to
+     * @param string $uid Name of the user
+     * @return array an array of group names
+     *
+     * This function fetches all groups a user belongs to. It does not check
+     * if the user exists at all.
+     */
+    public function getUserGroups($uid) {
+        return array();
+    }
 
-	/**
-	 * get a list of all groups
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array an array of group names
-	 *
-	 * Returns a list with all groups
-	 */
+    /**
+     * get a list of all groups
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array an array of group names
+     *
+     * Returns a list with all groups
+     */
 
-	public function getGroups($search = '', $limit = -1, $offset = 0) {
-		return array();
-	}
+    public function getGroups($search = '', $limit = -1, $offset = 0) {
+        return array();
+    }
 
-	/**
-	 * check if a group exists
-	 * @param string $gid
-	 * @return bool
-	 */
-	public function groupExists($gid) {
-		return in_array($gid, $this->getGroups($gid, 1));
-	}
+    /**
+     * check if a group exists
+     * @param string $gid
+     * @return bool
+     */
+    public function groupExists($gid) {
+        return in_array($gid, $this->getGroups($gid, 1));
+    }
 
-	/**
-	 * get a list of all users in a group
-	 * @param string $gid
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array an array of user ids
-	 */
-	public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
-		return array();
-	}
+    /**
+     * get a list of all users in a group
+     * @param string $gid
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array an array of user ids
+     */
+    public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
+        return array();
+    }
 }

ocs/v2.php

Spacing +1 added lines, -1 removed lines

@@ -20,4 +20,4 @@
  *
  */
 
-require_once __DIR__ . '/v1.php';
+require_once __DIR__.'/v1.php';