Passed
Push — master ( b306a8...3e64be )
by Roeland
09:52 queued 10s
created
lib/private/Encryption/Exceptions/EncryptionFailedException.php 1 patch
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -26,6 +26,6 @@
 block discarded – undo
26 26
 
27 27
 use OCP\Encryption\Exceptions\GenericEncryptionException;
28 28
 
29
-class EncryptionFailedException extends GenericEncryptionException{
29
+class EncryptionFailedException extends GenericEncryptionException {
30 30
 
31 31
 }
Please login to merge, or discard this patch.
lib/private/Encryption/Exceptions/EmptyEncryptionDataException.php 1 patch
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -26,6 +26,6 @@
 block discarded – undo
26 26
 
27 27
 use OCP\Encryption\Exceptions\GenericEncryptionException;
28 28
 
29
-class EmptyEncryptionDataException extends GenericEncryptionException{
29
+class EmptyEncryptionDataException extends GenericEncryptionException {
30 30
 
31 31
 }
Please login to merge, or discard this patch.
lib/private/Encryption/File.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -58,7 +58,7 @@
 block discarded – undo
58 58
 		// always add owner to the list of users with access to the file
59 59
 		$userIds = array($owner);
60 60
 
61
-		if (!$this->util->isFile($owner . '/' . $ownerPath)) {
61
+		if (!$this->util->isFile($owner.'/'.$ownerPath)) {
62 62
 			return array('users' => $userIds, 'public' => false);
63 63
 		}
64 64
 
Please login to merge, or discard this patch.
Indentation   +90 added lines, -90 removed lines patch added patch discarded remove patch
@@ -31,95 +31,95 @@
 block discarded – undo
31 31
 
32 32
 class File implements \OCP\Encryption\IFile {
33 33
 
34
-	/** @var Util */
35
-	protected $util;
36
-
37
-	/** @var IRootFolder */
38
-	private $rootFolder;
39
-
40
-	/** @var IManager */
41
-	private $shareManager;
42
-
43
-	/**
44
-	 * cache results of already checked folders
45
-	 *
46
-	 * @var array
47
-	 */
48
-	protected $cache;
49
-
50
-	public function __construct(Util $util,
51
-								IRootFolder $rootFolder,
52
-								IManager $shareManager) {
53
-		$this->util = $util;
54
-		$this->cache = new CappedMemoryCache();
55
-		$this->rootFolder = $rootFolder;
56
-		$this->shareManager = $shareManager;
57
-	}
58
-
59
-
60
-	/**
61
-	 * get list of users with access to the file
62
-	 *
63
-	 * @param string $path to the file
64
-	 * @return array  ['users' => $uniqueUserIds, 'public' => $public]
65
-	 */
66
-	public function getAccessList($path) {
67
-
68
-		// Make sure that a share key is generated for the owner too
69
-		list($owner, $ownerPath) = $this->util->getUidAndFilename($path);
70
-
71
-		// always add owner to the list of users with access to the file
72
-		$userIds = array($owner);
73
-
74
-		if (!$this->util->isFile($owner . '/' . $ownerPath)) {
75
-			return array('users' => $userIds, 'public' => false);
76
-		}
77
-
78
-		$ownerPath = substr($ownerPath, strlen('/files'));
79
-		$userFolder = $this->rootFolder->getUserFolder($owner);
80
-		try {
81
-			$file = $userFolder->get($ownerPath);
82
-		} catch (NotFoundException $e) {
83
-			$file = null;
84
-		}
85
-		$ownerPath = $this->util->stripPartialFileExtension($ownerPath);
86
-
87
-		// first get the shares for the parent and cache the result so that we don't
88
-		// need to check all parents for every file
89
-		$parent = dirname($ownerPath);
90
-		$parentNode = $userFolder->get($parent);
91
-		if (isset($this->cache[$parent])) {
92
-			$resultForParents = $this->cache[$parent];
93
-		} else {
94
-			$resultForParents = $this->shareManager->getAccessList($parentNode);
95
-			$this->cache[$parent] = $resultForParents;
96
-		}
97
-		$userIds = array_merge($userIds, $resultForParents['users']);
98
-		$public = $resultForParents['public'] || $resultForParents['remote'];
99
-
100
-
101
-		// Find out who, if anyone, is sharing the file
102
-		if ($file !== null) {
103
-			$resultForFile = $this->shareManager->getAccessList($file, false);
104
-			$userIds = array_merge($userIds, $resultForFile['users']);
105
-			$public = $resultForFile['public'] || $resultForFile['remote'] || $public;
106
-		}
107
-
108
-		// check if it is a group mount
109
-		if (\OCP\App::isEnabled("files_external")) {
110
-			$mounts = \OC_Mount_Config::getSystemMountPoints();
111
-			foreach ($mounts as $mount) {
112
-				if ($mount['mountpoint'] == substr($ownerPath, 1, strlen($mount['mountpoint']))) {
113
-					$mountedFor = $this->util->getUserWithAccessToMountPoint($mount['applicable']['users'], $mount['applicable']['groups']);
114
-					$userIds = array_merge($userIds, $mountedFor);
115
-				}
116
-			}
117
-		}
118
-
119
-		// Remove duplicate UIDs
120
-		$uniqueUserIds = array_unique($userIds);
121
-
122
-		return array('users' => $uniqueUserIds, 'public' => $public);
123
-	}
34
+    /** @var Util */
35
+    protected $util;
36
+
37
+    /** @var IRootFolder */
38
+    private $rootFolder;
39
+
40
+    /** @var IManager */
41
+    private $shareManager;
42
+
43
+    /**
44
+     * cache results of already checked folders
45
+     *
46
+     * @var array
47
+     */
48
+    protected $cache;
49
+
50
+    public function __construct(Util $util,
51
+                                IRootFolder $rootFolder,
52
+                                IManager $shareManager) {
53
+        $this->util = $util;
54
+        $this->cache = new CappedMemoryCache();
55
+        $this->rootFolder = $rootFolder;
56
+        $this->shareManager = $shareManager;
57
+    }
58
+
59
+
60
+    /**
61
+     * get list of users with access to the file
62
+     *
63
+     * @param string $path to the file
64
+     * @return array  ['users' => $uniqueUserIds, 'public' => $public]
65
+     */
66
+    public function getAccessList($path) {
67
+
68
+        // Make sure that a share key is generated for the owner too
69
+        list($owner, $ownerPath) = $this->util->getUidAndFilename($path);
70
+
71
+        // always add owner to the list of users with access to the file
72
+        $userIds = array($owner);
73
+
74
+        if (!$this->util->isFile($owner . '/' . $ownerPath)) {
75
+            return array('users' => $userIds, 'public' => false);
76
+        }
77
+
78
+        $ownerPath = substr($ownerPath, strlen('/files'));
79
+        $userFolder = $this->rootFolder->getUserFolder($owner);
80
+        try {
81
+            $file = $userFolder->get($ownerPath);
82
+        } catch (NotFoundException $e) {
83
+            $file = null;
84
+        }
85
+        $ownerPath = $this->util->stripPartialFileExtension($ownerPath);
86
+
87
+        // first get the shares for the parent and cache the result so that we don't
88
+        // need to check all parents for every file
89
+        $parent = dirname($ownerPath);
90
+        $parentNode = $userFolder->get($parent);
91
+        if (isset($this->cache[$parent])) {
92
+            $resultForParents = $this->cache[$parent];
93
+        } else {
94
+            $resultForParents = $this->shareManager->getAccessList($parentNode);
95
+            $this->cache[$parent] = $resultForParents;
96
+        }
97
+        $userIds = array_merge($userIds, $resultForParents['users']);
98
+        $public = $resultForParents['public'] || $resultForParents['remote'];
99
+
100
+
101
+        // Find out who, if anyone, is sharing the file
102
+        if ($file !== null) {
103
+            $resultForFile = $this->shareManager->getAccessList($file, false);
104
+            $userIds = array_merge($userIds, $resultForFile['users']);
105
+            $public = $resultForFile['public'] || $resultForFile['remote'] || $public;
106
+        }
107
+
108
+        // check if it is a group mount
109
+        if (\OCP\App::isEnabled("files_external")) {
110
+            $mounts = \OC_Mount_Config::getSystemMountPoints();
111
+            foreach ($mounts as $mount) {
112
+                if ($mount['mountpoint'] == substr($ownerPath, 1, strlen($mount['mountpoint']))) {
113
+                    $mountedFor = $this->util->getUserWithAccessToMountPoint($mount['applicable']['users'], $mount['applicable']['groups']);
114
+                    $userIds = array_merge($userIds, $mountedFor);
115
+                }
116
+            }
117
+        }
118
+
119
+        // Remove duplicate UIDs
120
+        $uniqueUserIds = array_unique($userIds);
121
+
122
+        return array('users' => $uniqueUserIds, 'public' => $public);
123
+    }
124 124
 
125 125
 }
Please login to merge, or discard this patch.
lib/private/Encryption/Keys/Storage.php 2 patches
Spacing   +19 added lines, -19 removed lines patch added patch discarded remove patch
@@ -66,8 +66,8 @@  discard block
 block discarded – undo
66 66
 		$this->util = $util;
67 67
 
68 68
 		$this->encryption_base_dir = '/files_encryption';
69
-		$this->keys_base_dir = $this->encryption_base_dir .'/keys';
70
-		$this->backup_base_dir = $this->encryption_base_dir .'/backup';
69
+		$this->keys_base_dir = $this->encryption_base_dir.'/keys';
70
+		$this->backup_base_dir = $this->encryption_base_dir.'/backup';
71 71
 		$this->root_dir = $this->util->getKeyStorageRoot();
72 72
 	}
73 73
 
@@ -85,14 +85,14 @@  discard block
 block discarded – undo
85 85
 	public function getFileKey($path, $keyId, $encryptionModuleId) {
86 86
 		$realFile = $this->util->stripPartialFileExtension($path);
87 87
 		$keyDir = $this->getFileKeyDir($encryptionModuleId, $realFile);
88
-		$key = $this->getKey($keyDir . $keyId);
88
+		$key = $this->getKey($keyDir.$keyId);
89 89
 
90 90
 		if ($key === '' && $realFile !== $path) {
91 91
 			// Check if the part file has keys and use them, if no normal keys
92 92
 			// exist. This is required to fix copyBetweenStorage() when we
93 93
 			// rename a .part file over storage borders.
94 94
 			$keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
95
-			$key = $this->getKey($keyDir . $keyId);
95
+			$key = $this->getKey($keyDir.$keyId);
96 96
 		}
97 97
 
98 98
 		return $key;
@@ -119,7 +119,7 @@  discard block
 block discarded – undo
119 119
 	 */
120 120
 	public function setFileKey($path, $keyId, $key, $encryptionModuleId) {
121 121
 		$keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
122
-		return $this->setKey($keyDir . $keyId, $key);
122
+		return $this->setKey($keyDir.$keyId, $key);
123 123
 	}
124 124
 
125 125
 	/**
@@ -143,7 +143,7 @@  discard block
 block discarded – undo
143 143
 	 */
144 144
 	public function deleteFileKey($path, $keyId, $encryptionModuleId) {
145 145
 		$keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
146
-		return !$this->view->file_exists($keyDir . $keyId) || $this->view->unlink($keyDir . $keyId);
146
+		return !$this->view->file_exists($keyDir.$keyId) || $this->view->unlink($keyDir.$keyId);
147 147
 	}
148 148
 
149 149
 	/**
@@ -173,10 +173,10 @@  discard block
 block discarded – undo
173 173
 	protected function constructUserKeyPath($encryptionModuleId, $keyId, $uid) {
174 174
 
175 175
 		if ($uid === null) {
176
-			$path = $this->root_dir . '/' . $this->encryption_base_dir . '/' . $encryptionModuleId . '/' . $keyId;
176
+			$path = $this->root_dir.'/'.$this->encryption_base_dir.'/'.$encryptionModuleId.'/'.$keyId;
177 177
 		} else {
178
-			$path = $this->root_dir . '/' . $uid . $this->encryption_base_dir . '/'
179
-				. $encryptionModuleId . '/' . $uid . '.' . $keyId;
178
+			$path = $this->root_dir.'/'.$uid.$this->encryption_base_dir.'/'
179
+				. $encryptionModuleId.'/'.$uid.'.'.$keyId;
180 180
 		}
181 181
 
182 182
 		return \OC\Files\Filesystem::normalizePath($path);
@@ -194,7 +194,7 @@  discard block
 block discarded – undo
194 194
 
195 195
 		if ($this->view->file_exists($path)) {
196 196
 			if (isset($this->keyCache[$path])) {
197
-				$key =  $this->keyCache[$path];
197
+				$key = $this->keyCache[$path];
198 198
 			} else {
199 199
 				$key = $this->view->file_get_contents($path);
200 200
 				$this->keyCache[$path] = $key;
@@ -238,12 +238,12 @@  discard block
 block discarded – undo
238 238
 
239 239
 		// in case of system wide mount points the keys are stored directly in the data directory
240 240
 		if ($this->util->isSystemWideMountPoint($filename, $owner)) {
241
-			$keyPath = $this->root_dir . '/' . $this->keys_base_dir . $filename . '/';
241
+			$keyPath = $this->root_dir.'/'.$this->keys_base_dir.$filename.'/';
242 242
 		} else {
243
-			$keyPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $filename . '/';
243
+			$keyPath = $this->root_dir.'/'.$owner.$this->keys_base_dir.$filename.'/';
244 244
 		}
245 245
 
246
-		return Filesystem::normalizePath($keyPath . $encryptionModuleId . '/', false);
246
+		return Filesystem::normalizePath($keyPath.$encryptionModuleId.'/', false);
247 247
 	}
248 248
 
249 249
 	/**
@@ -300,13 +300,13 @@  discard block
 block discarded – undo
300 300
 	 * @since 12.0.0
301 301
 	 */
302 302
 	public function backupUserKeys($encryptionModuleId, $purpose, $uid) {
303
-		$source = $uid . $this->encryption_base_dir . '/' . $encryptionModuleId;
304
-		$backupDir = $uid . $this->backup_base_dir;
303
+		$source = $uid.$this->encryption_base_dir.'/'.$encryptionModuleId;
304
+		$backupDir = $uid.$this->backup_base_dir;
305 305
 		if (!$this->view->file_exists($backupDir)) {
306 306
 			$this->view->mkdir($backupDir);
307 307
 		}
308 308
 
309
-		$backupDir = $backupDir . '/' . $purpose . '.' . $encryptionModuleId . '.' . $this->getTimestamp();
309
+		$backupDir = $backupDir.'/'.$purpose.'.'.$encryptionModuleId.'.'.$this->getTimestamp();
310 310
 		$this->view->mkdir($backupDir);
311 311
 
312 312
 		return $this->view->copy($source, $backupDir);
@@ -332,9 +332,9 @@  discard block
 block discarded – undo
332 332
 		$systemWideMountPoint = $this->util->isSystemWideMountPoint($relativePath, $owner);
333 333
 
334 334
 		if ($systemWideMountPoint) {
335
-			$systemPath = $this->root_dir . '/' . $this->keys_base_dir . $relativePath . '/';
335
+			$systemPath = $this->root_dir.'/'.$this->keys_base_dir.$relativePath.'/';
336 336
 		} else {
337
-			$systemPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $relativePath . '/';
337
+			$systemPath = $this->root_dir.'/'.$owner.$this->keys_base_dir.$relativePath.'/';
338 338
 		}
339 339
 
340 340
 		return  Filesystem::normalizePath($systemPath, false);
@@ -351,7 +351,7 @@  discard block
 block discarded – undo
351 351
 			$sub_dirs = explode('/', ltrim($path, '/'));
352 352
 			$dir = '';
353 353
 			foreach ($sub_dirs as $sub_dir) {
354
-				$dir .= '/' . $sub_dir;
354
+				$dir .= '/'.$sub_dir;
355 355
 				if (!$this->view->is_dir($dir)) {
356 356
 					$this->view->mkdir($dir);
357 357
 				}
Please login to merge, or discard this patch.
Indentation   +340 added lines, -340 removed lines patch added patch discarded remove patch
@@ -32,345 +32,345 @@
 block discarded – undo
32 32
 
33 33
 class Storage implements IStorage {
34 34
 
35
-	// hidden file which indicate that the folder is a valid key storage
36
-	const KEY_STORAGE_MARKER = '.oc_key_storage';
37
-
38
-	/** @var View */
39
-	private $view;
40
-
41
-	/** @var Util */
42
-	private $util;
43
-
44
-	// base dir where all the file related keys are stored
45
-	/** @var string */
46
-	private $keys_base_dir;
47
-
48
-	// root of the key storage default is empty which means that we use the data folder
49
-	/** @var string */
50
-	private $root_dir;
51
-
52
-	/** @var string */
53
-	private $encryption_base_dir;
54
-
55
-	/** @var string */
56
-	private $backup_base_dir;
57
-
58
-	/** @var array */
59
-	private $keyCache = [];
60
-
61
-	/**
62
-	 * @param View $view
63
-	 * @param Util $util
64
-	 */
65
-	public function __construct(View $view, Util $util) {
66
-		$this->view = $view;
67
-		$this->util = $util;
68
-
69
-		$this->encryption_base_dir = '/files_encryption';
70
-		$this->keys_base_dir = $this->encryption_base_dir .'/keys';
71
-		$this->backup_base_dir = $this->encryption_base_dir .'/backup';
72
-		$this->root_dir = $this->util->getKeyStorageRoot();
73
-	}
74
-
75
-	/**
76
-	 * @inheritdoc
77
-	 */
78
-	public function getUserKey($uid, $keyId, $encryptionModuleId) {
79
-		$path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid);
80
-		return $this->getKey($path);
81
-	}
82
-
83
-	/**
84
-	 * @inheritdoc
85
-	 */
86
-	public function getFileKey($path, $keyId, $encryptionModuleId) {
87
-		$realFile = $this->util->stripPartialFileExtension($path);
88
-		$keyDir = $this->getFileKeyDir($encryptionModuleId, $realFile);
89
-		$key = $this->getKey($keyDir . $keyId);
90
-
91
-		if ($key === '' && $realFile !== $path) {
92
-			// Check if the part file has keys and use them, if no normal keys
93
-			// exist. This is required to fix copyBetweenStorage() when we
94
-			// rename a .part file over storage borders.
95
-			$keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
96
-			$key = $this->getKey($keyDir . $keyId);
97
-		}
98
-
99
-		return $key;
100
-	}
101
-
102
-	/**
103
-	 * @inheritdoc
104
-	 */
105
-	public function getSystemUserKey($keyId, $encryptionModuleId) {
106
-		$path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null);
107
-		return $this->getKey($path);
108
-	}
109
-
110
-	/**
111
-	 * @inheritdoc
112
-	 */
113
-	public function setUserKey($uid, $keyId, $key, $encryptionModuleId) {
114
-		$path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid);
115
-		return $this->setKey($path, $key);
116
-	}
117
-
118
-	/**
119
-	 * @inheritdoc
120
-	 */
121
-	public function setFileKey($path, $keyId, $key, $encryptionModuleId) {
122
-		$keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
123
-		return $this->setKey($keyDir . $keyId, $key);
124
-	}
125
-
126
-	/**
127
-	 * @inheritdoc
128
-	 */
129
-	public function setSystemUserKey($keyId, $key, $encryptionModuleId) {
130
-		$path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null);
131
-		return $this->setKey($path, $key);
132
-	}
133
-
134
-	/**
135
-	 * @inheritdoc
136
-	 */
137
-	public function deleteUserKey($uid, $keyId, $encryptionModuleId) {
138
-		try {
139
-			$path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid);
140
-			return !$this->view->file_exists($path) || $this->view->unlink($path);
141
-		} catch (NoUserException $e) {
142
-			// this exception can come from initMountPoints() from setupUserMounts()
143
-			// for a deleted user.
144
-			//
145
-			// It means, that:
146
-			// - we are not running in alternative storage mode because we don't call
147
-			// initMountPoints() in that mode
148
-			// - the keys were in the user's home but since the user was deleted, the
149
-			// user's home is gone and so are the keys
150
-			//
151
-			// So there is nothing to do, just ignore.
152
-		}
153
-	}
154
-
155
-	/**
156
-	 * @inheritdoc
157
-	 */
158
-	public function deleteFileKey($path, $keyId, $encryptionModuleId) {
159
-		$keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
160
-		return !$this->view->file_exists($keyDir . $keyId) || $this->view->unlink($keyDir . $keyId);
161
-	}
162
-
163
-	/**
164
-	 * @inheritdoc
165
-	 */
166
-	public function deleteAllFileKeys($path) {
167
-		$keyDir = $this->getFileKeyDir('', $path);
168
-		return !$this->view->file_exists($keyDir) || $this->view->deleteAll($keyDir);
169
-	}
170
-
171
-	/**
172
-	 * @inheritdoc
173
-	 */
174
-	public function deleteSystemUserKey($keyId, $encryptionModuleId) {
175
-		$path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null);
176
-		return !$this->view->file_exists($path) || $this->view->unlink($path);
177
-	}
178
-
179
-	/**
180
-	 * construct path to users key
181
-	 *
182
-	 * @param string $encryptionModuleId
183
-	 * @param string $keyId
184
-	 * @param string $uid
185
-	 * @return string
186
-	 */
187
-	protected function constructUserKeyPath($encryptionModuleId, $keyId, $uid) {
188
-
189
-		if ($uid === null) {
190
-			$path = $this->root_dir . '/' . $this->encryption_base_dir . '/' . $encryptionModuleId . '/' . $keyId;
191
-		} else {
192
-			$path = $this->root_dir . '/' . $uid . $this->encryption_base_dir . '/'
193
-				. $encryptionModuleId . '/' . $uid . '.' . $keyId;
194
-		}
195
-
196
-		return \OC\Files\Filesystem::normalizePath($path);
197
-	}
198
-
199
-	/**
200
-	 * read key from hard disk
201
-	 *
202
-	 * @param string $path to key
203
-	 * @return string
204
-	 */
205
-	private function getKey($path) {
206
-
207
-		$key = '';
208
-
209
-		if ($this->view->file_exists($path)) {
210
-			if (isset($this->keyCache[$path])) {
211
-				$key =  $this->keyCache[$path];
212
-			} else {
213
-				$key = $this->view->file_get_contents($path);
214
-				$this->keyCache[$path] = $key;
215
-			}
216
-		}
217
-
218
-		return $key;
219
-	}
220
-
221
-	/**
222
-	 * write key to disk
223
-	 *
224
-	 *
225
-	 * @param string $path path to key directory
226
-	 * @param string $key key
227
-	 * @return bool
228
-	 */
229
-	private function setKey($path, $key) {
230
-		$this->keySetPreparation(dirname($path));
231
-
232
-		$result = $this->view->file_put_contents($path, $key);
233
-
234
-		if (is_int($result) && $result > 0) {
235
-			$this->keyCache[$path] = $key;
236
-			return true;
237
-		}
238
-
239
-		return false;
240
-	}
241
-
242
-	/**
243
-	 * get path to key folder for a given file
244
-	 *
245
-	 * @param string $encryptionModuleId
246
-	 * @param string $path path to the file, relative to data/
247
-	 * @return string
248
-	 */
249
-	private function getFileKeyDir($encryptionModuleId, $path) {
250
-
251
-		list($owner, $filename) = $this->util->getUidAndFilename($path);
252
-
253
-		// in case of system wide mount points the keys are stored directly in the data directory
254
-		if ($this->util->isSystemWideMountPoint($filename, $owner)) {
255
-			$keyPath = $this->root_dir . '/' . $this->keys_base_dir . $filename . '/';
256
-		} else {
257
-			$keyPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $filename . '/';
258
-		}
259
-
260
-		return Filesystem::normalizePath($keyPath . $encryptionModuleId . '/', false);
261
-	}
262
-
263
-	/**
264
-	 * move keys if a file was renamed
265
-	 *
266
-	 * @param string $source
267
-	 * @param string $target
268
-	 * @return boolean
269
-	 */
270
-	public function renameKeys($source, $target) {
271
-
272
-		$sourcePath = $this->getPathToKeys($source);
273
-		$targetPath = $this->getPathToKeys($target);
274
-
275
-		if ($this->view->file_exists($sourcePath)) {
276
-			$this->keySetPreparation(dirname($targetPath));
277
-			$this->view->rename($sourcePath, $targetPath);
278
-
279
-			return true;
280
-		}
281
-
282
-		return false;
283
-	}
284
-
285
-
286
-	/**
287
-	 * copy keys if a file was renamed
288
-	 *
289
-	 * @param string $source
290
-	 * @param string $target
291
-	 * @return boolean
292
-	 */
293
-	public function copyKeys($source, $target) {
294
-
295
-		$sourcePath = $this->getPathToKeys($source);
296
-		$targetPath = $this->getPathToKeys($target);
297
-
298
-		if ($this->view->file_exists($sourcePath)) {
299
-			$this->keySetPreparation(dirname($targetPath));
300
-			$this->view->copy($sourcePath, $targetPath);
301
-			return true;
302
-		}
303
-
304
-		return false;
305
-	}
306
-
307
-	/**
308
-	 * backup keys of a given encryption module
309
-	 *
310
-	 * @param string $encryptionModuleId
311
-	 * @param string $purpose
312
-	 * @param string $uid
313
-	 * @return bool
314
-	 * @since 12.0.0
315
-	 */
316
-	public function backupUserKeys($encryptionModuleId, $purpose, $uid) {
317
-		$source = $uid . $this->encryption_base_dir . '/' . $encryptionModuleId;
318
-		$backupDir = $uid . $this->backup_base_dir;
319
-		if (!$this->view->file_exists($backupDir)) {
320
-			$this->view->mkdir($backupDir);
321
-		}
322
-
323
-		$backupDir = $backupDir . '/' . $purpose . '.' . $encryptionModuleId . '.' . $this->getTimestamp();
324
-		$this->view->mkdir($backupDir);
325
-
326
-		return $this->view->copy($source, $backupDir);
327
-	}
328
-
329
-	/**
330
-	 * get the current timestamp
331
-	 *
332
-	 * @return int
333
-	 */
334
-	protected function getTimestamp() {
335
-		return time();
336
-	}
337
-
338
-	/**
339
-	 * get system wide path and detect mount points
340
-	 *
341
-	 * @param string $path
342
-	 * @return string
343
-	 */
344
-	protected function getPathToKeys($path) {
345
-		list($owner, $relativePath) = $this->util->getUidAndFilename($path);
346
-		$systemWideMountPoint = $this->util->isSystemWideMountPoint($relativePath, $owner);
347
-
348
-		if ($systemWideMountPoint) {
349
-			$systemPath = $this->root_dir . '/' . $this->keys_base_dir . $relativePath . '/';
350
-		} else {
351
-			$systemPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $relativePath . '/';
352
-		}
353
-
354
-		return  Filesystem::normalizePath($systemPath, false);
355
-	}
356
-
357
-	/**
358
-	 * Make preparations to filesystem for saving a key file
359
-	 *
360
-	 * @param string $path relative to the views root
361
-	 */
362
-	protected function keySetPreparation($path) {
363
-		// If the file resides within a subdirectory, create it
364
-		if (!$this->view->file_exists($path)) {
365
-			$sub_dirs = explode('/', ltrim($path, '/'));
366
-			$dir = '';
367
-			foreach ($sub_dirs as $sub_dir) {
368
-				$dir .= '/' . $sub_dir;
369
-				if (!$this->view->is_dir($dir)) {
370
-					$this->view->mkdir($dir);
371
-				}
372
-			}
373
-		}
374
-	}
35
+    // hidden file which indicate that the folder is a valid key storage
36
+    const KEY_STORAGE_MARKER = '.oc_key_storage';
37
+
38
+    /** @var View */
39
+    private $view;
40
+
41
+    /** @var Util */
42
+    private $util;
43
+
44
+    // base dir where all the file related keys are stored
45
+    /** @var string */
46
+    private $keys_base_dir;
47
+
48
+    // root of the key storage default is empty which means that we use the data folder
49
+    /** @var string */
50
+    private $root_dir;
51
+
52
+    /** @var string */
53
+    private $encryption_base_dir;
54
+
55
+    /** @var string */
56
+    private $backup_base_dir;
57
+
58
+    /** @var array */
59
+    private $keyCache = [];
60
+
61
+    /**
62
+     * @param View $view
63
+     * @param Util $util
64
+     */
65
+    public function __construct(View $view, Util $util) {
66
+        $this->view = $view;
67
+        $this->util = $util;
68
+
69
+        $this->encryption_base_dir = '/files_encryption';
70
+        $this->keys_base_dir = $this->encryption_base_dir .'/keys';
71
+        $this->backup_base_dir = $this->encryption_base_dir .'/backup';
72
+        $this->root_dir = $this->util->getKeyStorageRoot();
73
+    }
74
+
75
+    /**
76
+     * @inheritdoc
77
+     */
78
+    public function getUserKey($uid, $keyId, $encryptionModuleId) {
79
+        $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid);
80
+        return $this->getKey($path);
81
+    }
82
+
83
+    /**
84
+     * @inheritdoc
85
+     */
86
+    public function getFileKey($path, $keyId, $encryptionModuleId) {
87
+        $realFile = $this->util->stripPartialFileExtension($path);
88
+        $keyDir = $this->getFileKeyDir($encryptionModuleId, $realFile);
89
+        $key = $this->getKey($keyDir . $keyId);
90
+
91
+        if ($key === '' && $realFile !== $path) {
92
+            // Check if the part file has keys and use them, if no normal keys
93
+            // exist. This is required to fix copyBetweenStorage() when we
94
+            // rename a .part file over storage borders.
95
+            $keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
96
+            $key = $this->getKey($keyDir . $keyId);
97
+        }
98
+
99
+        return $key;
100
+    }
101
+
102
+    /**
103
+     * @inheritdoc
104
+     */
105
+    public function getSystemUserKey($keyId, $encryptionModuleId) {
106
+        $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null);
107
+        return $this->getKey($path);
108
+    }
109
+
110
+    /**
111
+     * @inheritdoc
112
+     */
113
+    public function setUserKey($uid, $keyId, $key, $encryptionModuleId) {
114
+        $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid);
115
+        return $this->setKey($path, $key);
116
+    }
117
+
118
+    /**
119
+     * @inheritdoc
120
+     */
121
+    public function setFileKey($path, $keyId, $key, $encryptionModuleId) {
122
+        $keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
123
+        return $this->setKey($keyDir . $keyId, $key);
124
+    }
125
+
126
+    /**
127
+     * @inheritdoc
128
+     */
129
+    public function setSystemUserKey($keyId, $key, $encryptionModuleId) {
130
+        $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null);
131
+        return $this->setKey($path, $key);
132
+    }
133
+
134
+    /**
135
+     * @inheritdoc
136
+     */
137
+    public function deleteUserKey($uid, $keyId, $encryptionModuleId) {
138
+        try {
139
+            $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid);
140
+            return !$this->view->file_exists($path) || $this->view->unlink($path);
141
+        } catch (NoUserException $e) {
142
+            // this exception can come from initMountPoints() from setupUserMounts()
143
+            // for a deleted user.
144
+            //
145
+            // It means, that:
146
+            // - we are not running in alternative storage mode because we don't call
147
+            // initMountPoints() in that mode
148
+            // - the keys were in the user's home but since the user was deleted, the
149
+            // user's home is gone and so are the keys
150
+            //
151
+            // So there is nothing to do, just ignore.
152
+        }
153
+    }
154
+
155
+    /**
156
+     * @inheritdoc
157
+     */
158
+    public function deleteFileKey($path, $keyId, $encryptionModuleId) {
159
+        $keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
160
+        return !$this->view->file_exists($keyDir . $keyId) || $this->view->unlink($keyDir . $keyId);
161
+    }
162
+
163
+    /**
164
+     * @inheritdoc
165
+     */
166
+    public function deleteAllFileKeys($path) {
167
+        $keyDir = $this->getFileKeyDir('', $path);
168
+        return !$this->view->file_exists($keyDir) || $this->view->deleteAll($keyDir);
169
+    }
170
+
171
+    /**
172
+     * @inheritdoc
173
+     */
174
+    public function deleteSystemUserKey($keyId, $encryptionModuleId) {
175
+        $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null);
176
+        return !$this->view->file_exists($path) || $this->view->unlink($path);
177
+    }
178
+
179
+    /**
180
+     * construct path to users key
181
+     *
182
+     * @param string $encryptionModuleId
183
+     * @param string $keyId
184
+     * @param string $uid
185
+     * @return string
186
+     */
187
+    protected function constructUserKeyPath($encryptionModuleId, $keyId, $uid) {
188
+
189
+        if ($uid === null) {
190
+            $path = $this->root_dir . '/' . $this->encryption_base_dir . '/' . $encryptionModuleId . '/' . $keyId;
191
+        } else {
192
+            $path = $this->root_dir . '/' . $uid . $this->encryption_base_dir . '/'
193
+                . $encryptionModuleId . '/' . $uid . '.' . $keyId;
194
+        }
195
+
196
+        return \OC\Files\Filesystem::normalizePath($path);
197
+    }
198
+
199
+    /**
200
+     * read key from hard disk
201
+     *
202
+     * @param string $path to key
203
+     * @return string
204
+     */
205
+    private function getKey($path) {
206
+
207
+        $key = '';
208
+
209
+        if ($this->view->file_exists($path)) {
210
+            if (isset($this->keyCache[$path])) {
211
+                $key =  $this->keyCache[$path];
212
+            } else {
213
+                $key = $this->view->file_get_contents($path);
214
+                $this->keyCache[$path] = $key;
215
+            }
216
+        }
217
+
218
+        return $key;
219
+    }
220
+
221
+    /**
222
+     * write key to disk
223
+     *
224
+     *
225
+     * @param string $path path to key directory
226
+     * @param string $key key
227
+     * @return bool
228
+     */
229
+    private function setKey($path, $key) {
230
+        $this->keySetPreparation(dirname($path));
231
+
232
+        $result = $this->view->file_put_contents($path, $key);
233
+
234
+        if (is_int($result) && $result > 0) {
235
+            $this->keyCache[$path] = $key;
236
+            return true;
237
+        }
238
+
239
+        return false;
240
+    }
241
+
242
+    /**
243
+     * get path to key folder for a given file
244
+     *
245
+     * @param string $encryptionModuleId
246
+     * @param string $path path to the file, relative to data/
247
+     * @return string
248
+     */
249
+    private function getFileKeyDir($encryptionModuleId, $path) {
250
+
251
+        list($owner, $filename) = $this->util->getUidAndFilename($path);
252
+
253
+        // in case of system wide mount points the keys are stored directly in the data directory
254
+        if ($this->util->isSystemWideMountPoint($filename, $owner)) {
255
+            $keyPath = $this->root_dir . '/' . $this->keys_base_dir . $filename . '/';
256
+        } else {
257
+            $keyPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $filename . '/';
258
+        }
259
+
260
+        return Filesystem::normalizePath($keyPath . $encryptionModuleId . '/', false);
261
+    }
262
+
263
+    /**
264
+     * move keys if a file was renamed
265
+     *
266
+     * @param string $source
267
+     * @param string $target
268
+     * @return boolean
269
+     */
270
+    public function renameKeys($source, $target) {
271
+
272
+        $sourcePath = $this->getPathToKeys($source);
273
+        $targetPath = $this->getPathToKeys($target);
274
+
275
+        if ($this->view->file_exists($sourcePath)) {
276
+            $this->keySetPreparation(dirname($targetPath));
277
+            $this->view->rename($sourcePath, $targetPath);
278
+
279
+            return true;
280
+        }
281
+
282
+        return false;
283
+    }
284
+
285
+
286
+    /**
287
+     * copy keys if a file was renamed
288
+     *
289
+     * @param string $source
290
+     * @param string $target
291
+     * @return boolean
292
+     */
293
+    public function copyKeys($source, $target) {
294
+
295
+        $sourcePath = $this->getPathToKeys($source);
296
+        $targetPath = $this->getPathToKeys($target);
297
+
298
+        if ($this->view->file_exists($sourcePath)) {
299
+            $this->keySetPreparation(dirname($targetPath));
300
+            $this->view->copy($sourcePath, $targetPath);
301
+            return true;
302
+        }
303
+
304
+        return false;
305
+    }
306
+
307
+    /**
308
+     * backup keys of a given encryption module
309
+     *
310
+     * @param string $encryptionModuleId
311
+     * @param string $purpose
312
+     * @param string $uid
313
+     * @return bool
314
+     * @since 12.0.0
315
+     */
316
+    public function backupUserKeys($encryptionModuleId, $purpose, $uid) {
317
+        $source = $uid . $this->encryption_base_dir . '/' . $encryptionModuleId;
318
+        $backupDir = $uid . $this->backup_base_dir;
319
+        if (!$this->view->file_exists($backupDir)) {
320
+            $this->view->mkdir($backupDir);
321
+        }
322
+
323
+        $backupDir = $backupDir . '/' . $purpose . '.' . $encryptionModuleId . '.' . $this->getTimestamp();
324
+        $this->view->mkdir($backupDir);
325
+
326
+        return $this->view->copy($source, $backupDir);
327
+    }
328
+
329
+    /**
330
+     * get the current timestamp
331
+     *
332
+     * @return int
333
+     */
334
+    protected function getTimestamp() {
335
+        return time();
336
+    }
337
+
338
+    /**
339
+     * get system wide path and detect mount points
340
+     *
341
+     * @param string $path
342
+     * @return string
343
+     */
344
+    protected function getPathToKeys($path) {
345
+        list($owner, $relativePath) = $this->util->getUidAndFilename($path);
346
+        $systemWideMountPoint = $this->util->isSystemWideMountPoint($relativePath, $owner);
347
+
348
+        if ($systemWideMountPoint) {
349
+            $systemPath = $this->root_dir . '/' . $this->keys_base_dir . $relativePath . '/';
350
+        } else {
351
+            $systemPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $relativePath . '/';
352
+        }
353
+
354
+        return  Filesystem::normalizePath($systemPath, false);
355
+    }
356
+
357
+    /**
358
+     * Make preparations to filesystem for saving a key file
359
+     *
360
+     * @param string $path relative to the views root
361
+     */
362
+    protected function keySetPreparation($path) {
363
+        // If the file resides within a subdirectory, create it
364
+        if (!$this->view->file_exists($path)) {
365
+            $sub_dirs = explode('/', ltrim($path, '/'));
366
+            $dir = '';
367
+            foreach ($sub_dirs as $sub_dir) {
368
+                $dir .= '/' . $sub_dir;
369
+                if (!$this->view->is_dir($dir)) {
370
+                    $this->view->mkdir($dir);
371
+                }
372
+            }
373
+        }
374
+    }
375 375
 
376 376
 }
Please login to merge, or discard this patch.
lib/private/Encryption/Manager.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -274,7 +274,7 @@
 block discarded – undo
274 274
 		}
275 275
 
276 276
 		// check if key storage is mounted correctly
277
-		if ($this->rootView->file_exists($rootDir . '/' . Storage::KEY_STORAGE_MARKER)) {
277
+		if ($this->rootView->file_exists($rootDir.'/'.Storage::KEY_STORAGE_MARKER)) {
278 278
 			return true;
279 279
 		}
280 280
 
Please login to merge, or discard this patch.
Indentation   +236 added lines, -236 removed lines patch added patch discarded remove patch
@@ -39,242 +39,242 @@
 block discarded – undo
39 39
 
40 40
 class Manager implements IManager {
41 41
 
42
-	/** @var array */
43
-	protected $encryptionModules;
44
-
45
-	/** @var IConfig */
46
-	protected $config;
47
-
48
-	/** @var ILogger */
49
-	protected $logger;
50
-
51
-	/** @var Il10n */
52
-	protected $l;
53
-
54
-	/** @var View  */
55
-	protected $rootView;
56
-
57
-	/** @var Util  */
58
-	protected $util;
59
-
60
-	/** @var ArrayCache  */
61
-	protected $arrayCache;
62
-
63
-	/**
64
-	 * @param IConfig $config
65
-	 * @param ILogger $logger
66
-	 * @param IL10N $l10n
67
-	 * @param View $rootView
68
-	 * @param Util $util
69
-	 * @param ArrayCache $arrayCache
70
-	 */
71
-	public function __construct(IConfig $config, ILogger $logger, IL10N $l10n, View $rootView, Util $util, ArrayCache $arrayCache) {
72
-		$this->encryptionModules = array();
73
-		$this->config = $config;
74
-		$this->logger = $logger;
75
-		$this->l = $l10n;
76
-		$this->rootView = $rootView;
77
-		$this->util = $util;
78
-		$this->arrayCache = $arrayCache;
79
-	}
80
-
81
-	/**
82
-	 * Check if encryption is enabled
83
-	 *
84
-	 * @return bool true if enabled, false if not
85
-	 */
86
-	public function isEnabled() {
87
-
88
-		$installed = $this->config->getSystemValue('installed', false);
89
-		if (!$installed) {
90
-			return false;
91
-		}
92
-
93
-		$enabled = $this->config->getAppValue('core', 'encryption_enabled', 'no');
94
-		return $enabled === 'yes';
95
-	}
96
-
97
-	/**
98
-	 * check if new encryption is ready
99
-	 *
100
-	 * @return bool
101
-	 * @throws ServiceUnavailableException
102
-	 */
103
-	public function isReady() {
104
-
105
-		if ($this->isKeyStorageReady() === false) {
106
-			throw new ServiceUnavailableException('Key Storage is not ready');
107
-		}
108
-
109
-		return true;
110
-	}
111
-
112
-	/**
113
-	 * @param string $user
114
-	 */
115
-	public function isReadyForUser($user) {
116
-		if (!$this->isReady()) {
117
-			return false;
118
-		}
119
-
120
-		foreach ($this->getEncryptionModules() as $module) {
121
-			/** @var IEncryptionModule $m */
122
-			$m = call_user_func($module['callback']);
123
-			if (!$m->isReadyForUser($user)) {
124
-				return false;
125
-			}
126
-		}
127
-
128
-		return true;
129
-	}
130
-
131
-		/**
132
-	 * Registers an callback function which must return an encryption module instance
133
-	 *
134
-	 * @param string $id
135
-	 * @param string $displayName
136
-	 * @param callable $callback
137
-	 * @throws Exceptions\ModuleAlreadyExistsException
138
-	 */
139
-	public function registerEncryptionModule($id, $displayName, callable $callback) {
140
-
141
-		if (isset($this->encryptionModules[$id])) {
142
-			throw new Exceptions\ModuleAlreadyExistsException($id, $displayName);
143
-		}
144
-
145
-		$this->encryptionModules[$id] = [
146
-			'id' => $id,
147
-			'displayName' => $displayName,
148
-			'callback' => $callback,
149
-		];
150
-
151
-		$defaultEncryptionModuleId = $this->getDefaultEncryptionModuleId();
152
-
153
-		if (empty($defaultEncryptionModuleId)) {
154
-			$this->setDefaultEncryptionModule($id);
155
-		}
156
-	}
157
-
158
-	/**
159
-	 * Unregisters an encryption module
160
-	 *
161
-	 * @param string $moduleId
162
-	 */
163
-	public function unregisterEncryptionModule($moduleId) {
164
-		unset($this->encryptionModules[$moduleId]);
165
-	}
166
-
167
-	/**
168
-	 * get a list of all encryption modules
169
-	 *
170
-	 * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]]
171
-	 */
172
-	public function getEncryptionModules() {
173
-		return $this->encryptionModules;
174
-	}
175
-
176
-	/**
177
-	 * get a specific encryption module
178
-	 *
179
-	 * @param string $moduleId
180
-	 * @return IEncryptionModule
181
-	 * @throws Exceptions\ModuleDoesNotExistsException
182
-	 */
183
-	public function getEncryptionModule($moduleId = '') {
184
-		if (!empty($moduleId)) {
185
-			if (isset($this->encryptionModules[$moduleId])) {
186
-				return call_user_func($this->encryptionModules[$moduleId]['callback']);
187
-			} else {
188
-				$message = "Module with ID: $moduleId does not exist.";
189
-				$hint = $this->l->t('Module with ID: %s does not exist. Please enable it in your apps settings or contact your administrator.', [$moduleId]);
190
-				throw new Exceptions\ModuleDoesNotExistsException($message, $hint);
191
-			}
192
-		} else {
193
-			return $this->getDefaultEncryptionModule();
194
-		}
195
-	}
196
-
197
-	/**
198
-	 * get default encryption module
199
-	 *
200
-	 * @return \OCP\Encryption\IEncryptionModule
201
-	 * @throws Exceptions\ModuleDoesNotExistsException
202
-	 */
203
-	protected function getDefaultEncryptionModule() {
204
-		$defaultModuleId = $this->getDefaultEncryptionModuleId();
205
-		if (!empty($defaultModuleId)) {
206
-			if (isset($this->encryptionModules[$defaultModuleId])) {
207
-				return call_user_func($this->encryptionModules[$defaultModuleId]['callback']);
208
-			} else {
209
-				$message = 'Default encryption module not loaded';
210
-				throw new Exceptions\ModuleDoesNotExistsException($message);
211
-			}
212
-		} else {
213
-			$message = 'No default encryption module defined';
214
-			throw new Exceptions\ModuleDoesNotExistsException($message);
215
-		}
216
-
217
-	}
218
-
219
-	/**
220
-	 * set default encryption module Id
221
-	 *
222
-	 * @param string $moduleId
223
-	 * @return bool
224
-	 */
225
-	public function setDefaultEncryptionModule($moduleId) {
226
-		try {
227
-			$this->getEncryptionModule($moduleId);
228
-		} catch (\Exception $e) {
229
-			return false;
230
-		}
231
-
232
-		$this->config->setAppValue('core', 'default_encryption_module', $moduleId);
233
-		return true;
234
-	}
235
-
236
-	/**
237
-	 * get default encryption module Id
238
-	 *
239
-	 * @return string
240
-	 */
241
-	public function getDefaultEncryptionModuleId() {
242
-		return $this->config->getAppValue('core', 'default_encryption_module');
243
-	}
244
-
245
-	/**
246
-	 * Add storage wrapper
247
-	 */
248
-	public function setupStorage() {
249
-		// If encryption is disabled and there are no loaded modules it makes no sense to load the wrapper
250
-		if (!empty($this->encryptionModules) || $this->isEnabled()) {
251
-			$encryptionWrapper = new EncryptionWrapper($this->arrayCache, $this, $this->logger);
252
-			Filesystem::addStorageWrapper('oc_encryption', array($encryptionWrapper, 'wrapStorage'), 2);
253
-		}
254
-	}
255
-
256
-
257
-	/**
258
-	 * check if key storage is ready
259
-	 *
260
-	 * @return bool
261
-	 */
262
-	protected function isKeyStorageReady() {
263
-
264
-		$rootDir = $this->util->getKeyStorageRoot();
265
-
266
-		// the default root is always valid
267
-		if ($rootDir === '') {
268
-			return true;
269
-		}
270
-
271
-		// check if key storage is mounted correctly
272
-		if ($this->rootView->file_exists($rootDir . '/' . Storage::KEY_STORAGE_MARKER)) {
273
-			return true;
274
-		}
275
-
276
-		return false;
277
-	}
42
+    /** @var array */
43
+    protected $encryptionModules;
44
+
45
+    /** @var IConfig */
46
+    protected $config;
47
+
48
+    /** @var ILogger */
49
+    protected $logger;
50
+
51
+    /** @var Il10n */
52
+    protected $l;
53
+
54
+    /** @var View  */
55
+    protected $rootView;
56
+
57
+    /** @var Util  */
58
+    protected $util;
59
+
60
+    /** @var ArrayCache  */
61
+    protected $arrayCache;
62
+
63
+    /**
64
+     * @param IConfig $config
65
+     * @param ILogger $logger
66
+     * @param IL10N $l10n
67
+     * @param View $rootView
68
+     * @param Util $util
69
+     * @param ArrayCache $arrayCache
70
+     */
71
+    public function __construct(IConfig $config, ILogger $logger, IL10N $l10n, View $rootView, Util $util, ArrayCache $arrayCache) {
72
+        $this->encryptionModules = array();
73
+        $this->config = $config;
74
+        $this->logger = $logger;
75
+        $this->l = $l10n;
76
+        $this->rootView = $rootView;
77
+        $this->util = $util;
78
+        $this->arrayCache = $arrayCache;
79
+    }
80
+
81
+    /**
82
+     * Check if encryption is enabled
83
+     *
84
+     * @return bool true if enabled, false if not
85
+     */
86
+    public function isEnabled() {
87
+
88
+        $installed = $this->config->getSystemValue('installed', false);
89
+        if (!$installed) {
90
+            return false;
91
+        }
92
+
93
+        $enabled = $this->config->getAppValue('core', 'encryption_enabled', 'no');
94
+        return $enabled === 'yes';
95
+    }
96
+
97
+    /**
98
+     * check if new encryption is ready
99
+     *
100
+     * @return bool
101
+     * @throws ServiceUnavailableException
102
+     */
103
+    public function isReady() {
104
+
105
+        if ($this->isKeyStorageReady() === false) {
106
+            throw new ServiceUnavailableException('Key Storage is not ready');
107
+        }
108
+
109
+        return true;
110
+    }
111
+
112
+    /**
113
+     * @param string $user
114
+     */
115
+    public function isReadyForUser($user) {
116
+        if (!$this->isReady()) {
117
+            return false;
118
+        }
119
+
120
+        foreach ($this->getEncryptionModules() as $module) {
121
+            /** @var IEncryptionModule $m */
122
+            $m = call_user_func($module['callback']);
123
+            if (!$m->isReadyForUser($user)) {
124
+                return false;
125
+            }
126
+        }
127
+
128
+        return true;
129
+    }
130
+
131
+        /**
132
+         * Registers an callback function which must return an encryption module instance
133
+         *
134
+         * @param string $id
135
+         * @param string $displayName
136
+         * @param callable $callback
137
+         * @throws Exceptions\ModuleAlreadyExistsException
138
+         */
139
+    public function registerEncryptionModule($id, $displayName, callable $callback) {
140
+
141
+        if (isset($this->encryptionModules[$id])) {
142
+            throw new Exceptions\ModuleAlreadyExistsException($id, $displayName);
143
+        }
144
+
145
+        $this->encryptionModules[$id] = [
146
+            'id' => $id,
147
+            'displayName' => $displayName,
148
+            'callback' => $callback,
149
+        ];
150
+
151
+        $defaultEncryptionModuleId = $this->getDefaultEncryptionModuleId();
152
+
153
+        if (empty($defaultEncryptionModuleId)) {
154
+            $this->setDefaultEncryptionModule($id);
155
+        }
156
+    }
157
+
158
+    /**
159
+     * Unregisters an encryption module
160
+     *
161
+     * @param string $moduleId
162
+     */
163
+    public function unregisterEncryptionModule($moduleId) {
164
+        unset($this->encryptionModules[$moduleId]);
165
+    }
166
+
167
+    /**
168
+     * get a list of all encryption modules
169
+     *
170
+     * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]]
171
+     */
172
+    public function getEncryptionModules() {
173
+        return $this->encryptionModules;
174
+    }
175
+
176
+    /**
177
+     * get a specific encryption module
178
+     *
179
+     * @param string $moduleId
180
+     * @return IEncryptionModule
181
+     * @throws Exceptions\ModuleDoesNotExistsException
182
+     */
183
+    public function getEncryptionModule($moduleId = '') {
184
+        if (!empty($moduleId)) {
185
+            if (isset($this->encryptionModules[$moduleId])) {
186
+                return call_user_func($this->encryptionModules[$moduleId]['callback']);
187
+            } else {
188
+                $message = "Module with ID: $moduleId does not exist.";
189
+                $hint = $this->l->t('Module with ID: %s does not exist. Please enable it in your apps settings or contact your administrator.', [$moduleId]);
190
+                throw new Exceptions\ModuleDoesNotExistsException($message, $hint);
191
+            }
192
+        } else {
193
+            return $this->getDefaultEncryptionModule();
194
+        }
195
+    }
196
+
197
+    /**
198
+     * get default encryption module
199
+     *
200
+     * @return \OCP\Encryption\IEncryptionModule
201
+     * @throws Exceptions\ModuleDoesNotExistsException
202
+     */
203
+    protected function getDefaultEncryptionModule() {
204
+        $defaultModuleId = $this->getDefaultEncryptionModuleId();
205
+        if (!empty($defaultModuleId)) {
206
+            if (isset($this->encryptionModules[$defaultModuleId])) {
207
+                return call_user_func($this->encryptionModules[$defaultModuleId]['callback']);
208
+            } else {
209
+                $message = 'Default encryption module not loaded';
210
+                throw new Exceptions\ModuleDoesNotExistsException($message);
211
+            }
212
+        } else {
213
+            $message = 'No default encryption module defined';
214
+            throw new Exceptions\ModuleDoesNotExistsException($message);
215
+        }
216
+
217
+    }
218
+
219
+    /**
220
+     * set default encryption module Id
221
+     *
222
+     * @param string $moduleId
223
+     * @return bool
224
+     */
225
+    public function setDefaultEncryptionModule($moduleId) {
226
+        try {
227
+            $this->getEncryptionModule($moduleId);
228
+        } catch (\Exception $e) {
229
+            return false;
230
+        }
231
+
232
+        $this->config->setAppValue('core', 'default_encryption_module', $moduleId);
233
+        return true;
234
+    }
235
+
236
+    /**
237
+     * get default encryption module Id
238
+     *
239
+     * @return string
240
+     */
241
+    public function getDefaultEncryptionModuleId() {
242
+        return $this->config->getAppValue('core', 'default_encryption_module');
243
+    }
244
+
245
+    /**
246
+     * Add storage wrapper
247
+     */
248
+    public function setupStorage() {
249
+        // If encryption is disabled and there are no loaded modules it makes no sense to load the wrapper
250
+        if (!empty($this->encryptionModules) || $this->isEnabled()) {
251
+            $encryptionWrapper = new EncryptionWrapper($this->arrayCache, $this, $this->logger);
252
+            Filesystem::addStorageWrapper('oc_encryption', array($encryptionWrapper, 'wrapStorage'), 2);
253
+        }
254
+    }
255
+
256
+
257
+    /**
258
+     * check if key storage is ready
259
+     *
260
+     * @return bool
261
+     */
262
+    protected function isKeyStorageReady() {
263
+
264
+        $rootDir = $this->util->getKeyStorageRoot();
265
+
266
+        // the default root is always valid
267
+        if ($rootDir === '') {
268
+            return true;
269
+        }
270
+
271
+        // check if key storage is mounted correctly
272
+        if ($this->rootView->file_exists($rootDir . '/' . Storage::KEY_STORAGE_MARKER)) {
273
+            return true;
274
+        }
275
+
276
+        return false;
277
+    }
278 278
 
279 279
 
280 280
 }
Please login to merge, or discard this patch.
lib/private/Encryption/HookManager.php 1 patch
Indentation   +41 added lines, -41 removed lines patch added patch discarded remove patch
@@ -27,50 +27,50 @@
 block discarded – undo
27 27
 use OC\Files\View;
28 28
 
29 29
 class HookManager {
30
-	/**
31
-	 * @var Update
32
-	 */
33
-	private static $updater;
30
+    /**
31
+     * @var Update
32
+     */
33
+    private static $updater;
34 34
 
35
-	public static function postShared($params) {
36
-		self::getUpdate()->postShared($params);
37
-	}
38
-	public static function postUnshared($params) {
39
-		self::getUpdate()->postUnshared($params);
40
-	}
35
+    public static function postShared($params) {
36
+        self::getUpdate()->postShared($params);
37
+    }
38
+    public static function postUnshared($params) {
39
+        self::getUpdate()->postUnshared($params);
40
+    }
41 41
 
42
-	public static function postRename($params) {
43
-		self::getUpdate()->postRename($params);
44
-	}
42
+    public static function postRename($params) {
43
+        self::getUpdate()->postRename($params);
44
+    }
45 45
 
46
-	public static function postRestore($params) {
47
-		self::getUpdate()->postRestore($params);
48
-	}
46
+    public static function postRestore($params) {
47
+        self::getUpdate()->postRestore($params);
48
+    }
49 49
 
50
-	/**
51
-	 * @return Update
52
-	 */
53
-	private static function getUpdate() {
54
-		if (is_null(self::$updater)) {
55
-			$user = \OC::$server->getUserSession()->getUser();
56
-			$uid = '';
57
-			if ($user) {
58
-				$uid = $user->getUID();
59
-			}
60
-			self::$updater = new Update(
61
-				new View(),
62
-				new Util(
63
-					new View(),
64
-					\OC::$server->getUserManager(),
65
-					\OC::$server->getGroupManager(),
66
-					\OC::$server->getConfig()),
67
-				Filesystem::getMountManager(),
68
-				\OC::$server->getEncryptionManager(),
69
-				\OC::$server->getEncryptionFilesHelper(),
70
-				$uid
71
-			);
72
-		}
50
+    /**
51
+     * @return Update
52
+     */
53
+    private static function getUpdate() {
54
+        if (is_null(self::$updater)) {
55
+            $user = \OC::$server->getUserSession()->getUser();
56
+            $uid = '';
57
+            if ($user) {
58
+                $uid = $user->getUID();
59
+            }
60
+            self::$updater = new Update(
61
+                new View(),
62
+                new Util(
63
+                    new View(),
64
+                    \OC::$server->getUserManager(),
65
+                    \OC::$server->getGroupManager(),
66
+                    \OC::$server->getConfig()),
67
+                Filesystem::getMountManager(),
68
+                \OC::$server->getEncryptionManager(),
69
+                \OC::$server->getEncryptionFilesHelper(),
70
+                $uid
71
+            );
72
+        }
73 73
 
74
-		return self::$updater;
75
-	}
74
+        return self::$updater;
75
+    }
76 76
 }
Please login to merge, or discard this patch.
lib/private/NaturalSort.php 3 patches
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -117,8 +117,8 @@
 block discarded – undo
117 117
 			if ($aChunk !== $bChunk) {
118 118
 				// test first character (character comparison, not number comparison)
119 119
 				if ($aChunk[0] >= '0' && $aChunk[0] <= '9' && $bChunk[0] >= '0' && $bChunk[0] <= '9') {
120
-					$aNum = (int)$aChunk;
121
-					$bNum = (int)$bChunk;
120
+					$aNum = (int) $aChunk;
121
+					$bNum = (int) $bChunk;
122 122
 					return $aNum - $bNum;
123 123
 				}
124 124
 				return self::getCollator()->compare($aChunk, $bChunk);
Please login to merge, or discard this patch.
Braces   +1 added lines, -2 removed lines patch added patch discarded remove patch
@@ -88,8 +88,7 @@
 block discarded – undo
88 88
 			// German umlauts, so using en_US instead
89 89
 			if (class_exists('Collator')) {
90 90
 				$this->collator = new \Collator('en_US');
91
-			}
92
-			else {
91
+			} else {
93 92
 				$this->collator = new \OC\NaturalSort_DefaultCollator();
94 93
 			}
95 94
 		}
Please login to merge, or discard this patch.
Indentation   +102 added lines, -102 removed lines patch added patch discarded remove patch
@@ -30,113 +30,113 @@
 block discarded – undo
30 30
 use OCP\ILogger;
31 31
 
32 32
 class NaturalSort {
33
-	private static $instance;
34
-	private $collator;
35
-	private $cache = array();
33
+    private static $instance;
34
+    private $collator;
35
+    private $cache = array();
36 36
 
37
-	/**
38
-	 * Instantiate a new \OC\NaturalSort instance.
39
-	 * @param object $injectedCollator
40
-	 */
41
-	public function __construct($injectedCollator = null) {
42
-		// inject an instance of \Collator('en_US') to force using the php5-intl Collator
43
-		// or inject an instance of \OC\NaturalSort_DefaultCollator to force using Owncloud's default collator
44
-		if (isset($injectedCollator)) {
45
-			$this->collator = $injectedCollator;
46
-			\OCP\Util::writeLog('core', 'forced use of '.get_class($injectedCollator), ILogger::DEBUG);
47
-		}
48
-	}
37
+    /**
38
+     * Instantiate a new \OC\NaturalSort instance.
39
+     * @param object $injectedCollator
40
+     */
41
+    public function __construct($injectedCollator = null) {
42
+        // inject an instance of \Collator('en_US') to force using the php5-intl Collator
43
+        // or inject an instance of \OC\NaturalSort_DefaultCollator to force using Owncloud's default collator
44
+        if (isset($injectedCollator)) {
45
+            $this->collator = $injectedCollator;
46
+            \OCP\Util::writeLog('core', 'forced use of '.get_class($injectedCollator), ILogger::DEBUG);
47
+        }
48
+    }
49 49
 
50
-	/**
51
-	 * Split the given string in chunks of numbers and strings
52
-	 * @param string $t string
53
-	 * @return array of strings and number chunks
54
-	 */
55
-	private function naturalSortChunkify($t) {
56
-		// Adapted and ported to PHP from
57
-		// http://my.opera.com/GreyWyvern/blog/show.dml/1671288
58
-		if (isset($this->cache[$t])) {
59
-			return $this->cache[$t];
60
-		}
61
-		$tz = array();
62
-		$x = 0;
63
-		$y = -1;
64
-		$n = null;
50
+    /**
51
+     * Split the given string in chunks of numbers and strings
52
+     * @param string $t string
53
+     * @return array of strings and number chunks
54
+     */
55
+    private function naturalSortChunkify($t) {
56
+        // Adapted and ported to PHP from
57
+        // http://my.opera.com/GreyWyvern/blog/show.dml/1671288
58
+        if (isset($this->cache[$t])) {
59
+            return $this->cache[$t];
60
+        }
61
+        $tz = array();
62
+        $x = 0;
63
+        $y = -1;
64
+        $n = null;
65 65
 
66
-		while (isset($t[$x])) {
67
-			$c = $t[$x];
68
-			// only include the dot in strings
69
-			$m = ((!$n && $c === '.') || ($c >= '0' && $c <= '9'));
70
-			if ($m !== $n) {
71
-				// next chunk
72
-				$y++;
73
-				$tz[$y] = '';
74
-				$n = $m;
75
-			}
76
-			$tz[$y] .= $c;
77
-			$x++;
78
-		}
79
-		$this->cache[$t] = $tz;
80
-		return $tz;
81
-	}
66
+        while (isset($t[$x])) {
67
+            $c = $t[$x];
68
+            // only include the dot in strings
69
+            $m = ((!$n && $c === '.') || ($c >= '0' && $c <= '9'));
70
+            if ($m !== $n) {
71
+                // next chunk
72
+                $y++;
73
+                $tz[$y] = '';
74
+                $n = $m;
75
+            }
76
+            $tz[$y] .= $c;
77
+            $x++;
78
+        }
79
+        $this->cache[$t] = $tz;
80
+        return $tz;
81
+    }
82 82
 
83
-	/**
84
-	 * Returns the string collator
85
-	 * @return \Collator string collator
86
-	 */
87
-	private function getCollator() {
88
-		if (!isset($this->collator)) {
89
-			// looks like the default is en_US_POSIX which yields wrong sorting with
90
-			// German umlauts, so using en_US instead
91
-			if (class_exists('Collator')) {
92
-				$this->collator = new \Collator('en_US');
93
-			}
94
-			else {
95
-				$this->collator = new \OC\NaturalSort_DefaultCollator();
96
-			}
97
-		}
98
-		return $this->collator;
99
-	}
83
+    /**
84
+     * Returns the string collator
85
+     * @return \Collator string collator
86
+     */
87
+    private function getCollator() {
88
+        if (!isset($this->collator)) {
89
+            // looks like the default is en_US_POSIX which yields wrong sorting with
90
+            // German umlauts, so using en_US instead
91
+            if (class_exists('Collator')) {
92
+                $this->collator = new \Collator('en_US');
93
+            }
94
+            else {
95
+                $this->collator = new \OC\NaturalSort_DefaultCollator();
96
+            }
97
+        }
98
+        return $this->collator;
99
+    }
100 100
 
101
-	/**
102
-	 * Compare two strings to provide a natural sort
103
-	 * @param string $a first string to compare
104
-	 * @param string $b second string to compare
105
-	 * @return int -1 if $b comes before $a, 1 if $a comes before $b
106
-	 * or 0 if the strings are identical
107
-	 */
108
-	public function compare($a, $b) {
109
-		// Needed because PHP doesn't sort correctly when numbers are enclosed in
110
-		// parenthesis, even with NUMERIC_COLLATION enabled.
111
-		// For example it gave ["test (2).txt", "test.txt"]
112
-		// instead of ["test.txt", "test (2).txt"]
113
-		$aa = self::naturalSortChunkify($a);
114
-		$bb = self::naturalSortChunkify($b);
101
+    /**
102
+     * Compare two strings to provide a natural sort
103
+     * @param string $a first string to compare
104
+     * @param string $b second string to compare
105
+     * @return int -1 if $b comes before $a, 1 if $a comes before $b
106
+     * or 0 if the strings are identical
107
+     */
108
+    public function compare($a, $b) {
109
+        // Needed because PHP doesn't sort correctly when numbers are enclosed in
110
+        // parenthesis, even with NUMERIC_COLLATION enabled.
111
+        // For example it gave ["test (2).txt", "test.txt"]
112
+        // instead of ["test.txt", "test (2).txt"]
113
+        $aa = self::naturalSortChunkify($a);
114
+        $bb = self::naturalSortChunkify($b);
115 115
 
116
-		for ($x = 0; isset($aa[$x]) && isset($bb[$x]); $x++) {
117
-			$aChunk = $aa[$x];
118
-			$bChunk = $bb[$x];
119
-			if ($aChunk !== $bChunk) {
120
-				// test first character (character comparison, not number comparison)
121
-				if ($aChunk[0] >= '0' && $aChunk[0] <= '9' && $bChunk[0] >= '0' && $bChunk[0] <= '9') {
122
-					$aNum = (int)$aChunk;
123
-					$bNum = (int)$bChunk;
124
-					return $aNum - $bNum;
125
-				}
126
-				return self::getCollator()->compare($aChunk, $bChunk);
127
-			}
128
-		}
129
-		return count($aa) - count($bb);
130
-	}
116
+        for ($x = 0; isset($aa[$x]) && isset($bb[$x]); $x++) {
117
+            $aChunk = $aa[$x];
118
+            $bChunk = $bb[$x];
119
+            if ($aChunk !== $bChunk) {
120
+                // test first character (character comparison, not number comparison)
121
+                if ($aChunk[0] >= '0' && $aChunk[0] <= '9' && $bChunk[0] >= '0' && $bChunk[0] <= '9') {
122
+                    $aNum = (int)$aChunk;
123
+                    $bNum = (int)$bChunk;
124
+                    return $aNum - $bNum;
125
+                }
126
+                return self::getCollator()->compare($aChunk, $bChunk);
127
+            }
128
+        }
129
+        return count($aa) - count($bb);
130
+    }
131 131
 
132
-	/**
133
-	 * Returns a singleton
134
-	 * @return \OC\NaturalSort instance
135
-	 */
136
-	public static function getInstance() {
137
-		if (!isset(self::$instance)) {
138
-			self::$instance = new \OC\NaturalSort();
139
-		}
140
-		return self::$instance;
141
-	}
132
+    /**
133
+     * Returns a singleton
134
+     * @return \OC\NaturalSort instance
135
+     */
136
+    public static function getInstance() {
137
+        if (!isset(self::$instance)) {
138
+            self::$instance = new \OC\NaturalSort();
139
+        }
140
+        return self::$instance;
141
+    }
142 142
 }
Please login to merge, or discard this patch.
lib/private/Group/Database.php 3 patches
Braces   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -168,7 +168,7 @@
 block discarded – undo
168 168
 				->setValue('gid', $qb->createNamedParameter($gid))
169 169
 				->execute();
170 170
 			return true;
171
-		}else{
171
+		} else{
172 172
 			return false;
173 173
 		}
174 174
 	}
Please login to merge, or discard this patch.
Spacing   +12 added lines, -12 removed lines patch added patch discarded remove patch
@@ -111,7 +111,7 @@  discard block
 block discarded – undo
111 111
 				->setValue('gid', $builder->createNamedParameter($gid))
112 112
 				->setValue('displayname', $builder->createNamedParameter($gid))
113 113
 				->execute();
114
-		} catch(UniqueConstraintViolationException $e) {
114
+		} catch (UniqueConstraintViolationException $e) {
115 115
 			$result = 0;
116 116
 		}
117 117
 
@@ -163,7 +163,7 @@  discard block
 block discarded – undo
163 163
 	 *
164 164
 	 * Checks whether the user is member of a group or not.
165 165
 	 */
166
-	public function inGroup( $uid, $gid ) {
166
+	public function inGroup($uid, $gid) {
167 167
 		$this->fixDI();
168 168
 
169 169
 		// check
@@ -192,14 +192,14 @@  discard block
 block discarded – undo
192 192
 		$this->fixDI();
193 193
 
194 194
 		// No duplicate entries!
195
-		if( !$this->inGroup( $uid, $gid )) {
195
+		if (!$this->inGroup($uid, $gid)) {
196 196
 			$qb = $this->dbConn->getQueryBuilder();
197 197
 			$qb->insert('group_user')
198 198
 				->setValue('uid', $qb->createNamedParameter($uid))
199 199
 				->setValue('gid', $qb->createNamedParameter($gid))
200 200
 				->execute();
201 201
 			return true;
202
-		}else{
202
+		} else {
203 203
 			return false;
204 204
 		}
205 205
 	}
@@ -232,7 +232,7 @@  discard block
 block discarded – undo
232 232
 	 * This function fetches all groups a user belongs to. It does not check
233 233
 	 * if the user exists at all.
234 234
 	 */
235
-	public function getUserGroups( $uid ) {
235
+	public function getUserGroups($uid) {
236 236
 		//guests has empty or null $uid
237 237
 		if ($uid === null || $uid === '') {
238 238
 			return [];
@@ -248,7 +248,7 @@  discard block
 block discarded – undo
248 248
 			->execute();
249 249
 
250 250
 		$groups = [];
251
-		while( $row = $cursor->fetch()) {
251
+		while ($row = $cursor->fetch()) {
252 252
 			$groups[] = $row['gid'];
253 253
 			$this->groupCache[$row['gid']] = $row['gid'];
254 254
 		}
@@ -276,7 +276,7 @@  discard block
 block discarded – undo
276 276
 
277 277
 		if ($search !== '') {
278 278
 			$query->where($query->expr()->iLike('gid', $query->createNamedParameter(
279
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
279
+				'%'.$this->dbConn->escapeLikeParameter($search).'%'
280 280
 			)));
281 281
 		}
282 282
 
@@ -340,7 +340,7 @@  discard block
 block discarded – undo
340 340
 
341 341
 		if ($search !== '') {
342 342
 			$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
343
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
343
+				'%'.$this->dbConn->escapeLikeParameter($search).'%'
344 344
 			)));
345 345
 		}
346 346
 
@@ -378,7 +378,7 @@  discard block
 block discarded – undo
378 378
 
379 379
 		if ($search !== '') {
380 380
 			$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
381
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
381
+				'%'.$this->dbConn->escapeLikeParameter($search).'%'
382 382
 			)));
383 383
 		}
384 384
 
@@ -387,7 +387,7 @@  discard block
 block discarded – undo
387 387
 		$result->closeCursor();
388 388
 
389 389
 		if ($count !== false) {
390
-			$count = (int)$count;
390
+			$count = (int) $count;
391 391
 		} else {
392 392
 			$count = 0;
393 393
 		}
@@ -405,7 +405,7 @@  discard block
 block discarded – undo
405 405
 		$this->fixDI();
406 406
 
407 407
 		$query = $this->dbConn->getQueryBuilder();
408
-		$query->select($query->createFunction('COUNT(DISTINCT ' . $query->getColumnName('uid') . ')'))
408
+		$query->select($query->createFunction('COUNT(DISTINCT '.$query->getColumnName('uid').')'))
409 409
 			->from('preferences', 'p')
410 410
 			->innerJoin('p', 'group_user', 'g', $query->expr()->eq('p.userid', 'g.uid'))
411 411
 			->where($query->expr()->eq('appid', $query->createNamedParameter('core')))
@@ -418,7 +418,7 @@  discard block
 block discarded – undo
418 418
 		$result->closeCursor();
419 419
 
420 420
 		if ($count !== false) {
421
-			$count = (int)$count;
421
+			$count = (int) $count;
422 422
 		} else {
423 423
 			$count = 0;
424 424
 		}
Please login to merge, or discard this patch.
Indentation   +412 added lines, -412 removed lines patch added patch discarded remove patch
@@ -60,417 +60,417 @@
 block discarded – undo
60 60
  * Class for group management in a SQL Database (e.g. MySQL, SQLite)
61 61
  */
62 62
 class Database extends ABackend
63
-	implements IAddToGroupBackend,
64
-	           ICountDisabledInGroup,
65
-	           ICountUsersBackend,
66
-	           ICreateGroupBackend,
67
-	           IDeleteGroupBackend,
68
-	           IGetDisplayNameBackend,
69
-	           IGroupDetailsBackend,
70
-	           IRemoveFromGroupBackend,
71
-	           ISetDisplayNameBackend {
72
-
73
-	/** @var string[] */
74
-	private $groupCache = [];
75
-
76
-	/** @var IDBConnection */
77
-	private $dbConn;
78
-
79
-	/**
80
-	 * \OC\Group\Database constructor.
81
-	 *
82
-	 * @param IDBConnection|null $dbConn
83
-	 */
84
-	public function __construct(IDBConnection $dbConn = null) {
85
-		$this->dbConn = $dbConn;
86
-	}
87
-
88
-	/**
89
-	 * FIXME: This function should not be required!
90
-	 */
91
-	private function fixDI() {
92
-		if ($this->dbConn === null) {
93
-			$this->dbConn = \OC::$server->getDatabaseConnection();
94
-		}
95
-	}
96
-
97
-	/**
98
-	 * Try to create a new group
99
-	 * @param string $gid The name of the group to create
100
-	 * @return bool
101
-	 *
102
-	 * Tries to create a new group. If the group name already exists, false will
103
-	 * be returned.
104
-	 */
105
-	public function createGroup(string $gid): bool {
106
-		$this->fixDI();
107
-
108
-		try {
109
-			// Add group
110
-			$builder = $this->dbConn->getQueryBuilder();
111
-			$result = $builder->insert('groups')
112
-				->setValue('gid', $builder->createNamedParameter($gid))
113
-				->setValue('displayname', $builder->createNamedParameter($gid))
114
-				->execute();
115
-		} catch(UniqueConstraintViolationException $e) {
116
-			$result = 0;
117
-		}
118
-
119
-		// Add to cache
120
-		$this->groupCache[$gid] = $gid;
121
-
122
-		return $result === 1;
123
-	}
124
-
125
-	/**
126
-	 * delete a group
127
-	 * @param string $gid gid of the group to delete
128
-	 * @return bool
129
-	 *
130
-	 * Deletes a group and removes it from the group_user-table
131
-	 */
132
-	public function deleteGroup(string $gid): bool {
133
-		$this->fixDI();
134
-
135
-		// Delete the group
136
-		$qb = $this->dbConn->getQueryBuilder();
137
-		$qb->delete('groups')
138
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
139
-			->execute();
140
-
141
-		// Delete the group-user relation
142
-		$qb = $this->dbConn->getQueryBuilder();
143
-		$qb->delete('group_user')
144
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
145
-			->execute();
146
-
147
-		// Delete the group-groupadmin relation
148
-		$qb = $this->dbConn->getQueryBuilder();
149
-		$qb->delete('group_admin')
150
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
151
-			->execute();
152
-
153
-		// Delete from cache
154
-		unset($this->groupCache[$gid]);
155
-
156
-		return true;
157
-	}
158
-
159
-	/**
160
-	 * is user in group?
161
-	 * @param string $uid uid of the user
162
-	 * @param string $gid gid of the group
163
-	 * @return bool
164
-	 *
165
-	 * Checks whether the user is member of a group or not.
166
-	 */
167
-	public function inGroup( $uid, $gid ) {
168
-		$this->fixDI();
169
-
170
-		// check
171
-		$qb = $this->dbConn->getQueryBuilder();
172
-		$cursor = $qb->select('uid')
173
-			->from('group_user')
174
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
175
-			->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
176
-			->execute();
177
-
178
-		$result = $cursor->fetch();
179
-		$cursor->closeCursor();
180
-
181
-		return $result ? true : false;
182
-	}
183
-
184
-	/**
185
-	 * Add a user to a group
186
-	 * @param string $uid Name of the user to add to group
187
-	 * @param string $gid Name of the group in which add the user
188
-	 * @return bool
189
-	 *
190
-	 * Adds a user to a group.
191
-	 */
192
-	public function addToGroup(string $uid, string $gid): bool {
193
-		$this->fixDI();
194
-
195
-		// No duplicate entries!
196
-		if( !$this->inGroup( $uid, $gid )) {
197
-			$qb = $this->dbConn->getQueryBuilder();
198
-			$qb->insert('group_user')
199
-				->setValue('uid', $qb->createNamedParameter($uid))
200
-				->setValue('gid', $qb->createNamedParameter($gid))
201
-				->execute();
202
-			return true;
203
-		}else{
204
-			return false;
205
-		}
206
-	}
207
-
208
-	/**
209
-	 * Removes a user from a group
210
-	 * @param string $uid Name of the user to remove from group
211
-	 * @param string $gid Name of the group from which remove the user
212
-	 * @return bool
213
-	 *
214
-	 * removes the user from a group.
215
-	 */
216
-	public function removeFromGroup(string $uid, string $gid): bool {
217
-		$this->fixDI();
218
-
219
-		$qb = $this->dbConn->getQueryBuilder();
220
-		$qb->delete('group_user')
221
-			->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
222
-			->andWhere($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
223
-			->execute();
224
-
225
-		return true;
226
-	}
227
-
228
-	/**
229
-	 * Get all groups a user belongs to
230
-	 * @param string $uid Name of the user
231
-	 * @return array an array of group names
232
-	 *
233
-	 * This function fetches all groups a user belongs to. It does not check
234
-	 * if the user exists at all.
235
-	 */
236
-	public function getUserGroups( $uid ) {
237
-		//guests has empty or null $uid
238
-		if ($uid === null || $uid === '') {
239
-			return [];
240
-		}
241
-
242
-		$this->fixDI();
243
-
244
-		// No magic!
245
-		$qb = $this->dbConn->getQueryBuilder();
246
-		$cursor = $qb->select('gid')
247
-			->from('group_user')
248
-			->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
249
-			->execute();
250
-
251
-		$groups = [];
252
-		while( $row = $cursor->fetch()) {
253
-			$groups[] = $row['gid'];
254
-			$this->groupCache[$row['gid']] = $row['gid'];
255
-		}
256
-		$cursor->closeCursor();
257
-
258
-		return $groups;
259
-	}
260
-
261
-	/**
262
-	 * get a list of all groups
263
-	 * @param string $search
264
-	 * @param int $limit
265
-	 * @param int $offset
266
-	 * @return array an array of group names
267
-	 *
268
-	 * Returns a list with all groups
269
-	 */
270
-	public function getGroups($search = '', $limit = null, $offset = null) {
271
-		$this->fixDI();
272
-
273
-		$query = $this->dbConn->getQueryBuilder();
274
-		$query->select('gid')
275
-			->from('groups')
276
-			->orderBy('gid', 'ASC');
277
-
278
-		if ($search !== '') {
279
-			$query->where($query->expr()->iLike('gid', $query->createNamedParameter(
280
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
281
-			)));
282
-		}
283
-
284
-		$query->setMaxResults($limit)
285
-			->setFirstResult($offset);
286
-		$result = $query->execute();
287
-
288
-		$groups = [];
289
-		while ($row = $result->fetch()) {
290
-			$groups[] = $row['gid'];
291
-		}
292
-		$result->closeCursor();
293
-
294
-		return $groups;
295
-	}
296
-
297
-	/**
298
-	 * check if a group exists
299
-	 * @param string $gid
300
-	 * @return bool
301
-	 */
302
-	public function groupExists($gid) {
303
-		$this->fixDI();
304
-
305
-		// Check cache first
306
-		if (isset($this->groupCache[$gid])) {
307
-			return true;
308
-		}
309
-
310
-		$qb = $this->dbConn->getQueryBuilder();
311
-		$cursor = $qb->select('gid')
312
-			->from('groups')
313
-			->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
314
-			->execute();
315
-		$result = $cursor->fetch();
316
-		$cursor->closeCursor();
317
-
318
-		if ($result !== false) {
319
-			$this->groupCache[$gid] = $gid;
320
-			return true;
321
-		}
322
-		return false;
323
-	}
324
-
325
-	/**
326
-	 * get a list of all users in a group
327
-	 * @param string $gid
328
-	 * @param string $search
329
-	 * @param int $limit
330
-	 * @param int $offset
331
-	 * @return array an array of user ids
332
-	 */
333
-	public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
334
-		$this->fixDI();
335
-
336
-		$query = $this->dbConn->getQueryBuilder();
337
-		$query->select('uid')
338
-			->from('group_user')
339
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)))
340
-			->orderBy('uid', 'ASC');
341
-
342
-		if ($search !== '') {
343
-			$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
344
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
345
-			)));
346
-		}
347
-
348
-		if ($limit !== -1) {
349
-			$query->setMaxResults($limit);
350
-		}
351
-		if ($offset !== 0) {
352
-			$query->setFirstResult($offset);
353
-		}
354
-
355
-		$result = $query->execute();
356
-
357
-		$users = [];
358
-		while ($row = $result->fetch()) {
359
-			$users[] = $row['uid'];
360
-		}
361
-		$result->closeCursor();
362
-
363
-		return $users;
364
-	}
365
-
366
-	/**
367
-	 * get the number of all users matching the search string in a group
368
-	 * @param string $gid
369
-	 * @param string $search
370
-	 * @return int
371
-	 */
372
-	public function countUsersInGroup(string $gid, string $search = ''): int {
373
-		$this->fixDI();
374
-
375
-		$query = $this->dbConn->getQueryBuilder();
376
-		$query->select($query->func()->count('*', 'num_users'))
377
-			->from('group_user')
378
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
379
-
380
-		if ($search !== '') {
381
-			$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
382
-				'%' . $this->dbConn->escapeLikeParameter($search) . '%'
383
-			)));
384
-		}
385
-
386
-		$result = $query->execute();
387
-		$count = $result->fetchColumn();
388
-		$result->closeCursor();
389
-
390
-		if ($count !== false) {
391
-			$count = (int)$count;
392
-		} else {
393
-			$count = 0;
394
-		}
395
-
396
-		return $count;
397
-	}
398
-
399
-	/**
400
-	 * get the number of disabled users in a group
401
-	 *
402
-	 * @param string $search
403
-	 *
404
-	 * @return int
405
-	 */
406
-	public function countDisabledInGroup(string $gid): int {
407
-		$this->fixDI();
408
-
409
-		$query = $this->dbConn->getQueryBuilder();
410
-		$query->select($query->createFunction('COUNT(DISTINCT ' . $query->getColumnName('uid') . ')'))
411
-			->from('preferences', 'p')
412
-			->innerJoin('p', 'group_user', 'g', $query->expr()->eq('p.userid', 'g.uid'))
413
-			->where($query->expr()->eq('appid', $query->createNamedParameter('core')))
414
-			->andWhere($query->expr()->eq('configkey', $query->createNamedParameter('enabled')))
415
-			->andWhere($query->expr()->eq('configvalue', $query->createNamedParameter('false'), IQueryBuilder::PARAM_STR))
416
-			->andWhere($query->expr()->eq('gid', $query->createNamedParameter($gid), IQueryBuilder::PARAM_STR));
417
-
418
-		$result = $query->execute();
419
-		$count = $result->fetchColumn();
420
-		$result->closeCursor();
421
-
422
-		if ($count !== false) {
423
-			$count = (int)$count;
424
-		} else {
425
-			$count = 0;
426
-		}
427
-
428
-		return $count;
429
-	}
430
-
431
-	public function getDisplayName(string $gid): string {
432
-		$this->fixDI();
433
-
434
-		$query = $this->dbConn->getQueryBuilder();
435
-		$query->select('displayname')
436
-			->from('groups')
437
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
438
-
439
-		$result = $query->execute();
440
-		$displayName = $result->fetchColumn();
441
-		$result->closeCursor();
442
-
443
-		return (string) $displayName;
444
-	}
445
-
446
-	public function getGroupDetails(string $gid): array {
447
-		$displayName = $this->getDisplayName($gid);
448
-		if ($displayName !== '') {
449
-			return ['displayName' => $displayName];
450
-		}
451
-
452
-		return [];
453
-	}
454
-
455
-	public function setDisplayName(string $gid, string $displayName): bool {
456
-		if (!$this->groupExists($gid)) {
457
-			return false;
458
-		}
459
-
460
-		$this->fixDI();
461
-
462
-		$displayName = trim($displayName);
463
-		if ($displayName === '') {
464
-			$displayName = $gid;
465
-		}
466
-
467
-		$query = $this->dbConn->getQueryBuilder();
468
-		$query->update('groups')
469
-			->set('displayname', $query->createNamedParameter($displayName))
470
-			->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
471
-		$query->execute();
472
-
473
-		return true;
474
-	}
63
+    implements IAddToGroupBackend,
64
+                ICountDisabledInGroup,
65
+                ICountUsersBackend,
66
+                ICreateGroupBackend,
67
+                IDeleteGroupBackend,
68
+                IGetDisplayNameBackend,
69
+                IGroupDetailsBackend,
70
+                IRemoveFromGroupBackend,
71
+                ISetDisplayNameBackend {
72
+
73
+    /** @var string[] */
74
+    private $groupCache = [];
75
+
76
+    /** @var IDBConnection */
77
+    private $dbConn;
78
+
79
+    /**
80
+     * \OC\Group\Database constructor.
81
+     *
82
+     * @param IDBConnection|null $dbConn
83
+     */
84
+    public function __construct(IDBConnection $dbConn = null) {
85
+        $this->dbConn = $dbConn;
86
+    }
87
+
88
+    /**
89
+     * FIXME: This function should not be required!
90
+     */
91
+    private function fixDI() {
92
+        if ($this->dbConn === null) {
93
+            $this->dbConn = \OC::$server->getDatabaseConnection();
94
+        }
95
+    }
96
+
97
+    /**
98
+     * Try to create a new group
99
+     * @param string $gid The name of the group to create
100
+     * @return bool
101
+     *
102
+     * Tries to create a new group. If the group name already exists, false will
103
+     * be returned.
104
+     */
105
+    public function createGroup(string $gid): bool {
106
+        $this->fixDI();
107
+
108
+        try {
109
+            // Add group
110
+            $builder = $this->dbConn->getQueryBuilder();
111
+            $result = $builder->insert('groups')
112
+                ->setValue('gid', $builder->createNamedParameter($gid))
113
+                ->setValue('displayname', $builder->createNamedParameter($gid))
114
+                ->execute();
115
+        } catch(UniqueConstraintViolationException $e) {
116
+            $result = 0;
117
+        }
118
+
119
+        // Add to cache
120
+        $this->groupCache[$gid] = $gid;
121
+
122
+        return $result === 1;
123
+    }
124
+
125
+    /**
126
+     * delete a group
127
+     * @param string $gid gid of the group to delete
128
+     * @return bool
129
+     *
130
+     * Deletes a group and removes it from the group_user-table
131
+     */
132
+    public function deleteGroup(string $gid): bool {
133
+        $this->fixDI();
134
+
135
+        // Delete the group
136
+        $qb = $this->dbConn->getQueryBuilder();
137
+        $qb->delete('groups')
138
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
139
+            ->execute();
140
+
141
+        // Delete the group-user relation
142
+        $qb = $this->dbConn->getQueryBuilder();
143
+        $qb->delete('group_user')
144
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
145
+            ->execute();
146
+
147
+        // Delete the group-groupadmin relation
148
+        $qb = $this->dbConn->getQueryBuilder();
149
+        $qb->delete('group_admin')
150
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
151
+            ->execute();
152
+
153
+        // Delete from cache
154
+        unset($this->groupCache[$gid]);
155
+
156
+        return true;
157
+    }
158
+
159
+    /**
160
+     * is user in group?
161
+     * @param string $uid uid of the user
162
+     * @param string $gid gid of the group
163
+     * @return bool
164
+     *
165
+     * Checks whether the user is member of a group or not.
166
+     */
167
+    public function inGroup( $uid, $gid ) {
168
+        $this->fixDI();
169
+
170
+        // check
171
+        $qb = $this->dbConn->getQueryBuilder();
172
+        $cursor = $qb->select('uid')
173
+            ->from('group_user')
174
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
175
+            ->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
176
+            ->execute();
177
+
178
+        $result = $cursor->fetch();
179
+        $cursor->closeCursor();
180
+
181
+        return $result ? true : false;
182
+    }
183
+
184
+    /**
185
+     * Add a user to a group
186
+     * @param string $uid Name of the user to add to group
187
+     * @param string $gid Name of the group in which add the user
188
+     * @return bool
189
+     *
190
+     * Adds a user to a group.
191
+     */
192
+    public function addToGroup(string $uid, string $gid): bool {
193
+        $this->fixDI();
194
+
195
+        // No duplicate entries!
196
+        if( !$this->inGroup( $uid, $gid )) {
197
+            $qb = $this->dbConn->getQueryBuilder();
198
+            $qb->insert('group_user')
199
+                ->setValue('uid', $qb->createNamedParameter($uid))
200
+                ->setValue('gid', $qb->createNamedParameter($gid))
201
+                ->execute();
202
+            return true;
203
+        }else{
204
+            return false;
205
+        }
206
+    }
207
+
208
+    /**
209
+     * Removes a user from a group
210
+     * @param string $uid Name of the user to remove from group
211
+     * @param string $gid Name of the group from which remove the user
212
+     * @return bool
213
+     *
214
+     * removes the user from a group.
215
+     */
216
+    public function removeFromGroup(string $uid, string $gid): bool {
217
+        $this->fixDI();
218
+
219
+        $qb = $this->dbConn->getQueryBuilder();
220
+        $qb->delete('group_user')
221
+            ->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
222
+            ->andWhere($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
223
+            ->execute();
224
+
225
+        return true;
226
+    }
227
+
228
+    /**
229
+     * Get all groups a user belongs to
230
+     * @param string $uid Name of the user
231
+     * @return array an array of group names
232
+     *
233
+     * This function fetches all groups a user belongs to. It does not check
234
+     * if the user exists at all.
235
+     */
236
+    public function getUserGroups( $uid ) {
237
+        //guests has empty or null $uid
238
+        if ($uid === null || $uid === '') {
239
+            return [];
240
+        }
241
+
242
+        $this->fixDI();
243
+
244
+        // No magic!
245
+        $qb = $this->dbConn->getQueryBuilder();
246
+        $cursor = $qb->select('gid')
247
+            ->from('group_user')
248
+            ->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)))
249
+            ->execute();
250
+
251
+        $groups = [];
252
+        while( $row = $cursor->fetch()) {
253
+            $groups[] = $row['gid'];
254
+            $this->groupCache[$row['gid']] = $row['gid'];
255
+        }
256
+        $cursor->closeCursor();
257
+
258
+        return $groups;
259
+    }
260
+
261
+    /**
262
+     * get a list of all groups
263
+     * @param string $search
264
+     * @param int $limit
265
+     * @param int $offset
266
+     * @return array an array of group names
267
+     *
268
+     * Returns a list with all groups
269
+     */
270
+    public function getGroups($search = '', $limit = null, $offset = null) {
271
+        $this->fixDI();
272
+
273
+        $query = $this->dbConn->getQueryBuilder();
274
+        $query->select('gid')
275
+            ->from('groups')
276
+            ->orderBy('gid', 'ASC');
277
+
278
+        if ($search !== '') {
279
+            $query->where($query->expr()->iLike('gid', $query->createNamedParameter(
280
+                '%' . $this->dbConn->escapeLikeParameter($search) . '%'
281
+            )));
282
+        }
283
+
284
+        $query->setMaxResults($limit)
285
+            ->setFirstResult($offset);
286
+        $result = $query->execute();
287
+
288
+        $groups = [];
289
+        while ($row = $result->fetch()) {
290
+            $groups[] = $row['gid'];
291
+        }
292
+        $result->closeCursor();
293
+
294
+        return $groups;
295
+    }
296
+
297
+    /**
298
+     * check if a group exists
299
+     * @param string $gid
300
+     * @return bool
301
+     */
302
+    public function groupExists($gid) {
303
+        $this->fixDI();
304
+
305
+        // Check cache first
306
+        if (isset($this->groupCache[$gid])) {
307
+            return true;
308
+        }
309
+
310
+        $qb = $this->dbConn->getQueryBuilder();
311
+        $cursor = $qb->select('gid')
312
+            ->from('groups')
313
+            ->where($qb->expr()->eq('gid', $qb->createNamedParameter($gid)))
314
+            ->execute();
315
+        $result = $cursor->fetch();
316
+        $cursor->closeCursor();
317
+
318
+        if ($result !== false) {
319
+            $this->groupCache[$gid] = $gid;
320
+            return true;
321
+        }
322
+        return false;
323
+    }
324
+
325
+    /**
326
+     * get a list of all users in a group
327
+     * @param string $gid
328
+     * @param string $search
329
+     * @param int $limit
330
+     * @param int $offset
331
+     * @return array an array of user ids
332
+     */
333
+    public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
334
+        $this->fixDI();
335
+
336
+        $query = $this->dbConn->getQueryBuilder();
337
+        $query->select('uid')
338
+            ->from('group_user')
339
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)))
340
+            ->orderBy('uid', 'ASC');
341
+
342
+        if ($search !== '') {
343
+            $query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
344
+                '%' . $this->dbConn->escapeLikeParameter($search) . '%'
345
+            )));
346
+        }
347
+
348
+        if ($limit !== -1) {
349
+            $query->setMaxResults($limit);
350
+        }
351
+        if ($offset !== 0) {
352
+            $query->setFirstResult($offset);
353
+        }
354
+
355
+        $result = $query->execute();
356
+
357
+        $users = [];
358
+        while ($row = $result->fetch()) {
359
+            $users[] = $row['uid'];
360
+        }
361
+        $result->closeCursor();
362
+
363
+        return $users;
364
+    }
365
+
366
+    /**
367
+     * get the number of all users matching the search string in a group
368
+     * @param string $gid
369
+     * @param string $search
370
+     * @return int
371
+     */
372
+    public function countUsersInGroup(string $gid, string $search = ''): int {
373
+        $this->fixDI();
374
+
375
+        $query = $this->dbConn->getQueryBuilder();
376
+        $query->select($query->func()->count('*', 'num_users'))
377
+            ->from('group_user')
378
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
379
+
380
+        if ($search !== '') {
381
+            $query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
382
+                '%' . $this->dbConn->escapeLikeParameter($search) . '%'
383
+            )));
384
+        }
385
+
386
+        $result = $query->execute();
387
+        $count = $result->fetchColumn();
388
+        $result->closeCursor();
389
+
390
+        if ($count !== false) {
391
+            $count = (int)$count;
392
+        } else {
393
+            $count = 0;
394
+        }
395
+
396
+        return $count;
397
+    }
398
+
399
+    /**
400
+     * get the number of disabled users in a group
401
+     *
402
+     * @param string $search
403
+     *
404
+     * @return int
405
+     */
406
+    public function countDisabledInGroup(string $gid): int {
407
+        $this->fixDI();
408
+
409
+        $query = $this->dbConn->getQueryBuilder();
410
+        $query->select($query->createFunction('COUNT(DISTINCT ' . $query->getColumnName('uid') . ')'))
411
+            ->from('preferences', 'p')
412
+            ->innerJoin('p', 'group_user', 'g', $query->expr()->eq('p.userid', 'g.uid'))
413
+            ->where($query->expr()->eq('appid', $query->createNamedParameter('core')))
414
+            ->andWhere($query->expr()->eq('configkey', $query->createNamedParameter('enabled')))
415
+            ->andWhere($query->expr()->eq('configvalue', $query->createNamedParameter('false'), IQueryBuilder::PARAM_STR))
416
+            ->andWhere($query->expr()->eq('gid', $query->createNamedParameter($gid), IQueryBuilder::PARAM_STR));
417
+
418
+        $result = $query->execute();
419
+        $count = $result->fetchColumn();
420
+        $result->closeCursor();
421
+
422
+        if ($count !== false) {
423
+            $count = (int)$count;
424
+        } else {
425
+            $count = 0;
426
+        }
427
+
428
+        return $count;
429
+    }
430
+
431
+    public function getDisplayName(string $gid): string {
432
+        $this->fixDI();
433
+
434
+        $query = $this->dbConn->getQueryBuilder();
435
+        $query->select('displayname')
436
+            ->from('groups')
437
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
438
+
439
+        $result = $query->execute();
440
+        $displayName = $result->fetchColumn();
441
+        $result->closeCursor();
442
+
443
+        return (string) $displayName;
444
+    }
445
+
446
+    public function getGroupDetails(string $gid): array {
447
+        $displayName = $this->getDisplayName($gid);
448
+        if ($displayName !== '') {
449
+            return ['displayName' => $displayName];
450
+        }
451
+
452
+        return [];
453
+    }
454
+
455
+    public function setDisplayName(string $gid, string $displayName): bool {
456
+        if (!$this->groupExists($gid)) {
457
+            return false;
458
+        }
459
+
460
+        $this->fixDI();
461
+
462
+        $displayName = trim($displayName);
463
+        if ($displayName === '') {
464
+            $displayName = $gid;
465
+        }
466
+
467
+        $query = $this->dbConn->getQueryBuilder();
468
+        $query->update('groups')
469
+            ->set('displayname', $query->createNamedParameter($displayName))
470
+            ->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
471
+        $query->execute();
472
+
473
+        return true;
474
+    }
475 475
 
476 476
 }
Please login to merge, or discard this patch.
lib/private/Group/Backend.php 2 patches
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -49,8 +49,8 @@  discard block
 block discarded – undo
49 49
 	*/
50 50
 	public function getSupportedActions() {
51 51
 		$actions = 0;
52
-		foreach($this->possibleActions AS $action => $methodName) {
53
-			if(method_exists($this, $methodName)) {
52
+		foreach ($this->possibleActions AS $action => $methodName) {
53
+			if (method_exists($this, $methodName)) {
54 54
 				$actions |= $action;
55 55
 			}
56 56
 		}
@@ -67,7 +67,7 @@  discard block
 block discarded – undo
67 67
 	* compared with \OC\Group\Backend::CREATE_GROUP etc.
68 68
 	*/
69 69
 	public function implementsActions($actions) {
70
-		return (bool)($this->getSupportedActions() & $actions);
70
+		return (bool) ($this->getSupportedActions() & $actions);
71 71
 	}
72 72
 
73 73
 	/**
Please login to merge, or discard this patch.
Indentation   +93 added lines, -93 removed lines patch added patch discarded remove patch
@@ -26,107 +26,107 @@
 block discarded – undo
26 26
  * Abstract base class for user management
27 27
  */
28 28
 abstract class Backend implements \OCP\GroupInterface {
29
-	/**
30
-	 * error code for functions not provided by the group backend
31
-	 */
32
-	const NOT_IMPLEMENTED = -501;
29
+    /**
30
+     * error code for functions not provided by the group backend
31
+     */
32
+    const NOT_IMPLEMENTED = -501;
33 33
 
34
-	protected $possibleActions = [
35
-		self::CREATE_GROUP => 'createGroup',
36
-		self::DELETE_GROUP => 'deleteGroup',
37
-		self::ADD_TO_GROUP => 'addToGroup',
38
-		self::REMOVE_FROM_GOUP => 'removeFromGroup',
39
-		self::COUNT_USERS => 'countUsersInGroup',
40
-		self::GROUP_DETAILS => 'getGroupDetails',
41
-		self::IS_ADMIN => 'isAdmin',
42
-	];
34
+    protected $possibleActions = [
35
+        self::CREATE_GROUP => 'createGroup',
36
+        self::DELETE_GROUP => 'deleteGroup',
37
+        self::ADD_TO_GROUP => 'addToGroup',
38
+        self::REMOVE_FROM_GOUP => 'removeFromGroup',
39
+        self::COUNT_USERS => 'countUsersInGroup',
40
+        self::GROUP_DETAILS => 'getGroupDetails',
41
+        self::IS_ADMIN => 'isAdmin',
42
+    ];
43 43
 
44
-	/**
45
-	* Get all supported actions
46
-	* @return int bitwise-or'ed actions
47
-	*
48
-	* Returns the supported actions as int to be
49
-	* compared with \OC\Group\Backend::CREATE_GROUP etc.
50
-	*/
51
-	public function getSupportedActions() {
52
-		$actions = 0;
53
-		foreach($this->possibleActions AS $action => $methodName) {
54
-			if(method_exists($this, $methodName)) {
55
-				$actions |= $action;
56
-			}
57
-		}
44
+    /**
45
+     * Get all supported actions
46
+     * @return int bitwise-or'ed actions
47
+     *
48
+     * Returns the supported actions as int to be
49
+     * compared with \OC\Group\Backend::CREATE_GROUP etc.
50
+     */
51
+    public function getSupportedActions() {
52
+        $actions = 0;
53
+        foreach($this->possibleActions AS $action => $methodName) {
54
+            if(method_exists($this, $methodName)) {
55
+                $actions |= $action;
56
+            }
57
+        }
58 58
 
59
-		return $actions;
60
-	}
59
+        return $actions;
60
+    }
61 61
 
62
-	/**
63
-	* Check if backend implements actions
64
-	* @param int $actions bitwise-or'ed actions
65
-	* @return bool
66
-	*
67
-	* Returns the supported actions as int to be
68
-	* compared with \OC\Group\Backend::CREATE_GROUP etc.
69
-	*/
70
-	public function implementsActions($actions) {
71
-		return (bool)($this->getSupportedActions() & $actions);
72
-	}
62
+    /**
63
+     * Check if backend implements actions
64
+     * @param int $actions bitwise-or'ed actions
65
+     * @return bool
66
+     *
67
+     * Returns the supported actions as int to be
68
+     * compared with \OC\Group\Backend::CREATE_GROUP etc.
69
+     */
70
+    public function implementsActions($actions) {
71
+        return (bool)($this->getSupportedActions() & $actions);
72
+    }
73 73
 
74
-	/**
75
-	 * is user in group?
76
-	 * @param string $uid uid of the user
77
-	 * @param string $gid gid of the group
78
-	 * @return bool
79
-	 *
80
-	 * Checks whether the user is member of a group or not.
81
-	 */
82
-	public function inGroup($uid, $gid) {
83
-		return in_array($gid, $this->getUserGroups($uid));
84
-	}
74
+    /**
75
+     * is user in group?
76
+     * @param string $uid uid of the user
77
+     * @param string $gid gid of the group
78
+     * @return bool
79
+     *
80
+     * Checks whether the user is member of a group or not.
81
+     */
82
+    public function inGroup($uid, $gid) {
83
+        return in_array($gid, $this->getUserGroups($uid));
84
+    }
85 85
 
86
-	/**
87
-	 * Get all groups a user belongs to
88
-	 * @param string $uid Name of the user
89
-	 * @return array an array of group names
90
-	 *
91
-	 * This function fetches all groups a user belongs to. It does not check
92
-	 * if the user exists at all.
93
-	 */
94
-	public function getUserGroups($uid) {
95
-		return array();
96
-	}
86
+    /**
87
+     * Get all groups a user belongs to
88
+     * @param string $uid Name of the user
89
+     * @return array an array of group names
90
+     *
91
+     * This function fetches all groups a user belongs to. It does not check
92
+     * if the user exists at all.
93
+     */
94
+    public function getUserGroups($uid) {
95
+        return array();
96
+    }
97 97
 
98
-	/**
99
-	 * get a list of all groups
100
-	 * @param string $search
101
-	 * @param int $limit
102
-	 * @param int $offset
103
-	 * @return array an array of group names
104
-	 *
105
-	 * Returns a list with all groups
106
-	 */
98
+    /**
99
+     * get a list of all groups
100
+     * @param string $search
101
+     * @param int $limit
102
+     * @param int $offset
103
+     * @return array an array of group names
104
+     *
105
+     * Returns a list with all groups
106
+     */
107 107
 
108
-	public function getGroups($search = '', $limit = -1, $offset = 0) {
109
-		return array();
110
-	}
108
+    public function getGroups($search = '', $limit = -1, $offset = 0) {
109
+        return array();
110
+    }
111 111
 
112
-	/**
113
-	 * check if a group exists
114
-	 * @param string $gid
115
-	 * @return bool
116
-	 */
117
-	public function groupExists($gid) {
118
-		return in_array($gid, $this->getGroups($gid, 1));
119
-	}
112
+    /**
113
+     * check if a group exists
114
+     * @param string $gid
115
+     * @return bool
116
+     */
117
+    public function groupExists($gid) {
118
+        return in_array($gid, $this->getGroups($gid, 1));
119
+    }
120 120
 
121
-	/**
122
-	 * get a list of all users in a group
123
-	 * @param string $gid
124
-	 * @param string $search
125
-	 * @param int $limit
126
-	 * @param int $offset
127
-	 * @return array an array of user ids
128
-	 */
129
-	public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
130
-		return array();
131
-	}
121
+    /**
122
+     * get a list of all users in a group
123
+     * @param string $gid
124
+     * @param string $search
125
+     * @param int $limit
126
+     * @param int $offset
127
+     * @return array an array of user ids
128
+     */
129
+    public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
130
+        return array();
131
+    }
132 132
 }
Please login to merge, or discard this patch.