allconfig.php 13.9 KB
Newer Older
1
2
<?php
/**
3
4
5
6
 * Copyright (c) 2013 Bart Visscher <bartv@thisnet.nl>
 * This file is licensed under the Affero General Public License version 3 or
 * later.
 * See the COPYING-README file.
7
 *
8
 */
9

10
namespace OC;
11
12

use OCP\IAppConfig;
13
use OCP\IDBConnection;
14
use OCP\PreConditionNotMetException;
15
16
17
18
19

/**
 * Class to combine all the configuration options ownCloud offers
 */
class AllConfig implements \OCP\IConfig {
20
21
22
	/** @var SystemConfig */
	private $systemConfig;

23
24
25
	/** @var IDBConnection */
	private $connection;

26
27
28
	/** @var IAppConfig */
	private $appConfig;

29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
	/**
	 * 3 dimensional array with the following structure:
	 * [ $userId =>
	 *     [ $appId =>
	 *         [ $key => $value ]
	 *     ]
	 * ]
	 *
	 * database table: preferences
	 *
	 * methods that use this:
	 *   - setUserValue
	 *   - getUserValue
	 *   - getUserKeys
	 *   - deleteUserValue
	 *   - deleteAllUserValues
	 *   - deleteAppFromAllUsers
	 *
	 * @var array $userCache
	 */
	private $userCache = array();

51
52
53
	/**
	 * @param SystemConfig $systemConfig
	 */
54
	function __construct(SystemConfig $systemConfig) {
55
		$this->systemConfig = $systemConfig;
56
57
58
59
60
61
62
63
64
65
66
67
68
69
	}

	/**
	 * TODO - FIXME This fixes an issue with base.php that cause cyclic
	 * dependencies, especially with autoconfig setup
	 *
	 * Replace this by properly injected database connection. Currently the
	 * base.php triggers the getDatabaseConnection too early which causes in
	 * autoconfig setup case a too early distributed database connection and
	 * the autoconfig then needs to reinit all already initialized dependencies
	 * that use the database connection.
	 *
	 * otherwise a SQLite database is created in the wrong directory
	 * because the database connection was created with an uninitialized config
70
71
72
	 *
	 * The same applies for the app config, because it uses the database
	 * connection itself
73
74
75
76
77
	 */
	private function fixDIInit() {
		if($this->connection === null) {
			$this->connection = \OC::$server->getDatabaseConnection();
		}
78
79
80
		if ($this->appConfig === null) {
			$this->appConfig = \OC::$server->getAppConfig();
		}
81
82
	}

83
84
85
86
87
88
89
90
91
92
	/**
	 * Sets and deletes system wide values
	 *
	 * @param array $configs Associative array with `key => value` pairs
	 *                       If value is null, the config key will be deleted
	 */
	public function setSystemValues(array $configs) {
		$this->systemConfig->setValues($configs);
	}

93
	/**
Thomas Müller's avatar
Thomas Müller committed
94
	 * Sets a new system wide value
95
	 *
96
	 * @param string $key the key of the value, under which will be saved
97
	 * @param mixed $value the value that should be stored
98
	 */
99
	public function setSystemValue($key, $value) {
100
		$this->systemConfig->setValue($key, $value);
Lukas Reschke's avatar
Lukas Reschke committed
101
	}
102
103

	/**
Thomas Müller's avatar
Thomas Müller committed
104
	 * Looks up a system wide defined value
105
	 *
106
	 * @param string $key the key of the value, under which it was saved
107
	 * @param mixed $default the default value to be returned if the value isn't set
108
	 * @return mixed the value or $default
109
	 */
110
	public function getSystemValue($key, $default = '') {
111
		return $this->systemConfig->getValue($key, $default);
112
113
	}

114
115
116
117
118
119
	/**
	 * Delete a system wide defined value
	 *
	 * @param string $key the key of the value, under which it was saved
	 */
	public function deleteSystemValue($key) {
120
		$this->systemConfig->deleteValue($key);
121
122
	}

123
124
125
126
127
128
129
	/**
	 * Get all keys stored for an app
	 *
	 * @param string $appName the appName that we stored the value under
	 * @return string[] the keys stored for the app
	 */
	public function getAppKeys($appName) {
130
131
132
133
		// TODO - FIXME
		$this->fixDIInit();

		return $this->appConfig->getKeys($appName);
134
	}
135
136

	/**
Thomas Müller's avatar
Thomas Müller committed
137
	 * Writes a new app wide value
138
	 *
139
140
141
142
143
	 * @param string $appName the appName that we want to store the value under
	 * @param string $key the key of the value, under which will be saved
	 * @param string $value the value that should be stored
	 */
	public function setAppValue($appName, $key, $value) {
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
		// TODO - FIXME
		$this->fixDIInit();

		$this->appConfig->setValue($appName, $key, $value);
	}

	/**
	 * Checks if a key is set in the apps config
	 *
	 * @param string $appName the appName tto look a key up
	 * @param string $key the key to look up
	 * @return bool
	 */
	public function hasAppKey($appName, $key) {
		// TODO - FIXME
		$this->fixDIInit();

		$this->appConfig->hasKey($appName, $key);
162
163
164
	}

	/**
Thomas Müller's avatar
Thomas Müller committed
165
	 * Looks up an app wide defined value
166
	 *
167
168
	 * @param string $appName the appName that we stored the value under
	 * @param string $key the key of the value, under which it was saved
169
	 * @param string $default the default value to be returned if the value isn't set
170
171
	 * @return string the saved value
	 */
172
	public function getAppValue($appName, $key, $default = '') {
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
		// TODO - FIXME
		$this->fixDIInit();

		return $this->appConfig->getValue($appName, $key, $default);
	}

	/**
	 * Get all app values that are stored
	 *
	 * @param string $appName the appName
	 * @return array with key - value pair as they are saved previously
	 */
	public function getAppValuesByApp($appName) {
		// TODO - FIXME
		$this->fixDIInit();

		return $this->appConfig->getValues($appName, false);
	}

	/**
	 * Get all app values that use the same key
	 *
	 * @param string $key the appName
	 * @return array with key - value pair as they are saved previously with the
	 *                 app name as key
	 */
	public function getAppValuesByKey($key) {
		// TODO - FIXME
		$this->fixDIInit();

		return $this->appConfig->getValues(false, $key);
	}

	/**
	 * Get all apps that have at least one value saved
	 *
	 * @return array containing app names
	 */
	public function getApps() {
		// TODO - FIXME
		$this->fixDIInit();

		return $this->appConfig->getApps();
216
217
	}

218
219
220
221
222
223
224
	/**
	 * Delete an app wide defined value
	 *
	 * @param string $appName the appName that we stored the value under
	 * @param string $key the key of the value, under which it was saved
	 */
	public function deleteAppValue($appName, $key) {
225
226
227
228
		// TODO - FIXME
		$this->fixDIInit();

		$this->appConfig->deleteKey($appName, $key);
229
230
	}

231
232
233
234
235
236
	/**
	 * Removes all keys in appconfig belonging to the app
	 *
	 * @param string $appName the appName the configs are stored under
	 */
	public function deleteAppValues($appName) {
237
238
239
240
		// TODO - FIXME
		$this->fixDIInit();

		$this->appConfig->deleteApp($appName);
241
242
	}

243
244
245

	/**
	 * Set a user defined value
246
	 *
247
248
249
250
	 * @param string $userId the userId of the user that we want to store the value under
	 * @param string $appName the appName that we want to store the value under
	 * @param string $key the key under which the value is being stored
	 * @param string $value the value that you want to store
251
252
	 * @param string $preCondition only update if the config value was previously the value passed as $preCondition
	 * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met
253
	 */
254
	public function setUserValue($userId, $appName, $key, $value, $preCondition = null) {
255
256
257
		// TODO - FIXME
		$this->fixDIInit();

258
259
260
261
262
		// Check if the key does exist
		$sql  = 'SELECT `configvalue` FROM `*PREFIX*preferences` '.
				'WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?';
		$result = $this->connection->executeQuery($sql, array($userId, $appName, $key));
		$oldValue = $result->fetchColumn();
263
		$result->closeCursor();
264
265
266
267
268
269
270
		$exists = $oldValue !== false;

		if($oldValue === strval($value)) {
			// no changes
			return;
		}

271
		$affectedRows = 0;
272
		if (!$exists && $preCondition === null) {
273
274
275
276
277
			$this->connection->insertIfNotExist('*PREFIX*preferences', [
				'configvalue'	=> $value,
				'userid'		=> $userId,
				'appid'			=> $appName,
				'configkey'		=> $key,
278
			], ['configkey', 'userid', 'appid']);
279
			$affectedRows = 1;
280
		} elseif ($exists) {
281
282
			$data = array($value, $userId, $appName, $key);

283
			$sql  = 'UPDATE `*PREFIX*preferences` SET `configvalue` = ? '.
284
285
286
287
288
289
290
291
292
293
294
					'WHERE `userid` = ? AND `appid` = ? AND `configkey` = ? ';

			if($preCondition !== null) {
				if($this->getSystemValue('dbtype', 'sqlite') === 'oci') {
					//oracle hack: need to explicitly cast CLOB to CHAR for comparison
					$sql .= 'AND to_char(`configvalue`) = ?';
				} else {
					$sql .= 'AND `configvalue` = ?';
				}
				$data[] = $preCondition;
			}
295
			$affectedRows = $this->connection->executeUpdate($sql, $data);
296
297
298
299
300
301
302
303
304
		}

		// only add to the cache if we already loaded data for the user
		if ($affectedRows > 0 && isset($this->userCache[$userId])) {
			if (!isset($this->userCache[$userId][$appName])) {
				$this->userCache[$userId][$appName] = array();
			}
			$this->userCache[$userId][$appName][$key] = $value;
		}
305
306
307
308

		if ($preCondition !== null && $affectedRows === 0) {
			throw new PreConditionNotMetException;
		}
309
310
311
	}

	/**
312
	 * Getting a user defined value
313
	 *
314
315
316
	 * @param string $userId the userId of the user that we want to store the value under
	 * @param string $appName the appName that we stored the value under
	 * @param string $key the key under which the value is being stored
317
318
	 * @param string $default the default value to be returned if the value isn't set
	 * @return string
319
	 */
320
	public function getUserValue($userId, $appName, $key, $default = '') {
321
322
323
324
325
326
		$data = $this->getUserValues($userId);
		if (isset($data[$appName]) and isset($data[$appName][$key])) {
			return $data[$appName][$key];
		} else {
			return $default;
		}
327
	}
328
329
330
331
332
333
334
335
336

	/**
	 * Get the keys of all stored by an app for the user
	 *
	 * @param string $userId the userId of the user that we want to store the value under
	 * @param string $appName the appName that we stored the value under
	 * @return string[]
	 */
	public function getUserKeys($userId, $appName) {
337
338
339
340
341
342
		$data = $this->getUserValues($userId);
		if (isset($data[$appName])) {
			return array_keys($data[$appName]);
		} else {
			return array();
		}
343
344
345
346
347
348
349
350
351
352
	}

	/**
	 * Delete a user value
	 *
	 * @param string $userId the userId of the user that we want to store the value under
	 * @param string $appName the appName that we stored the value under
	 * @param string $key the key under which the value is being stored
	 */
	public function deleteUserValue($userId, $appName, $key) {
353
354
355
		// TODO - FIXME
		$this->fixDIInit();

356
357
358
359
360
361
362
		$sql  = 'DELETE FROM `*PREFIX*preferences` '.
				'WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?';
		$this->connection->executeUpdate($sql, array($userId, $appName, $key));

		if (isset($this->userCache[$userId]) and isset($this->userCache[$userId][$appName])) {
			unset($this->userCache[$userId][$appName][$key]);
		}
363
	}
Morris Jobke's avatar
Morris Jobke committed
364
365
366
367
368
369
370

	/**
	 * Delete all user values
	 *
	 * @param string $userId the userId of the user that we want to remove all values from
	 */
	public function deleteAllUserValues($userId) {
371
372
373
		// TODO - FIXME
		$this->fixDIInit();

374
375
376
377
378
379
380
381
382
383
384
385
386
		$sql  = 'DELETE FROM `*PREFIX*preferences` '.
			'WHERE `userid` = ?';
		$this->connection->executeUpdate($sql, array($userId));

		unset($this->userCache[$userId]);
	}

	/**
	 * Delete all user related values of one app
	 *
	 * @param string $appName the appName of the app that we want to remove all values from
	 */
	public function deleteAppFromAllUsers($appName) {
387
388
389
		// TODO - FIXME
		$this->fixDIInit();

390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
		$sql  = 'DELETE FROM `*PREFIX*preferences` '.
				'WHERE `appid` = ?';
		$this->connection->executeUpdate($sql, array($appName));

		foreach ($this->userCache as &$userCache) {
			unset($userCache[$appName]);
		}
	}

	/**
	 * Returns all user configs sorted by app of one user
	 *
	 * @param string $userId the user ID to get the app configs from
	 * @return array[] - 2 dimensional array with the following structure:
	 *     [ $appId =>
	 *         [ $key => $value ]
	 *     ]
	 */
	private function getUserValues($userId) {
409
410
411
		// TODO - FIXME
		$this->fixDIInit();

412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
		if (isset($this->userCache[$userId])) {
			return $this->userCache[$userId];
		}
		$data = array();
		$query = 'SELECT `appid`, `configkey`, `configvalue` FROM `*PREFIX*preferences` WHERE `userid` = ?';
		$result = $this->connection->executeQuery($query, array($userId));
		while ($row = $result->fetch()) {
			$appId = $row['appid'];
			if (!isset($data[$appId])) {
				$data[$appId] = array();
			}
			$data[$appId][$row['configkey']] = $row['configvalue'];
		}
		$this->userCache[$userId] = $data;
		return $data;
	}

	/**
	 * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs.
	 *
432
433
434
	 * @param string $appName app to get the value for
	 * @param string $key the key to get the value for
	 * @param array $userIds the user IDs to fetch the values for
435
436
437
	 * @return array Mapped values: userId => value
	 */
	public function getUserValueForUsers($appName, $key, $userIds) {
438
439
440
		// TODO - FIXME
		$this->fixDIInit();

441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
		if (empty($userIds) || !is_array($userIds)) {
			return array();
		}

		$chunkedUsers = array_chunk($userIds, 50, true);
		$placeholders50 = implode(',', array_fill(0, 50, '?'));

		$userValues = array();
		foreach ($chunkedUsers as $chunk) {
			$queryParams = $chunk;
			// create [$app, $key, $chunkedUsers]
			array_unshift($queryParams, $key);
			array_unshift($queryParams, $appName);

			$placeholders = (sizeof($chunk) == 50) ? $placeholders50 :  implode(',', array_fill(0, sizeof($chunk), '?'));

			$query    = 'SELECT `userid`, `configvalue` ' .
						'FROM `*PREFIX*preferences` ' .
						'WHERE `appid` = ? AND `configkey` = ? ' .
						'AND `userid` IN (' . $placeholders . ')';
			$result = $this->connection->executeQuery($query, $queryParams);

			while ($row = $result->fetch()) {
				$userValues[$row['userid']] = $row['configvalue'];
			}
		}

		return $userValues;
	}

	/**
	 * Determines the users that have the given value set for a specific app-key-pair
	 *
	 * @param string $appName the app to get the user for
	 * @param string $key the key to get the user for
	 * @param string $value the value to get the user for
	 * @return array of user IDs
	 */
	public function getUsersForUserValue($appName, $key, $value) {
		// TODO - FIXME
		$this->fixDIInit();

		$sql  = 'SELECT `userid` FROM `*PREFIX*preferences` ' .
				'WHERE `appid` = ? AND `configkey` = ? ';

		if($this->getSystemValue('dbtype', 'sqlite') === 'oci') {
			//oracle hack: need to explicitly cast CLOB to CHAR for comparison
			$sql .= 'AND to_char(`configvalue`) = ?';
		} else {
			$sql .= 'AND `configvalue` = ?';
		}

		$result = $this->connection->executeQuery($sql, array($appName, $key, $value));

		$userIDs = array();
		while ($row = $result->fetch()) {
			$userIDs[] = $row['userid'];
		}

		return $userIDs;
Morris Jobke's avatar
Morris Jobke committed
501
	}
502
}