Completed
Pull Request — master (#8023)
by Robin
81:08 queued 62:00
created
apps/provisioning_api/lib/Controller/UsersController.php 4 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -225,7 +225,7 @@
 block discarded – undo
225 225
 	/**
226 226
 	 * creates a array with all user data
227 227
 	 *
228
-	 * @param $userId
228
+	 * @param string $userId
229 229
 	 * @return array
230 230
 	 * @throws OCSException
231 231
 	 */
Please login to merge, or discard this patch.
Braces   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -335,7 +335,7 @@
 block discarded – undo
335 335
 					}
336 336
 					if($quota === 0) {
337 337
 						$quota = 'default';
338
-					}else if($quota === -1) {
338
+					} else if($quota === -1) {
339 339
 						$quota = 'none';
340 340
 					} else {
341 341
 						$quota = \OCP\Util::humanFileSize($quota);
Please login to merge, or discard this patch.
Indentation   +790 added lines, -790 removed lines patch added patch discarded remove patch
@@ -50,794 +50,794 @@
 block discarded – undo
50 50
 
51 51
 class UsersController extends OCSController {
52 52
 
53
-	/** @var IUserManager */
54
-	private $userManager;
55
-	/** @var IConfig */
56
-	private $config;
57
-	/** @var IAppManager */
58
-	private $appManager;
59
-	/** @var IGroupManager|\OC\Group\Manager */ // FIXME Requires a method that is not on the interface
60
-	private $groupManager;
61
-	/** @var IUserSession */
62
-	private $userSession;
63
-	/** @var AccountManager */
64
-	private $accountManager;
65
-	/** @var ILogger */
66
-	private $logger;
67
-	/** @var IFactory */
68
-	private $l10nFactory;
69
-	/** @var NewUserMailHelper */
70
-	private $newUserMailHelper;
71
-
72
-	/**
73
-	 * @param string $appName
74
-	 * @param IRequest $request
75
-	 * @param IUserManager $userManager
76
-	 * @param IConfig $config
77
-	 * @param IAppManager $appManager
78
-	 * @param IGroupManager $groupManager
79
-	 * @param IUserSession $userSession
80
-	 * @param AccountManager $accountManager
81
-	 * @param ILogger $logger
82
-	 * @param IFactory $l10nFactory
83
-	 * @param NewUserMailHelper $newUserMailHelper
84
-	 */
85
-	public function __construct($appName,
86
-								IRequest $request,
87
-								IUserManager $userManager,
88
-								IConfig $config,
89
-								IAppManager $appManager,
90
-								IGroupManager $groupManager,
91
-								IUserSession $userSession,
92
-								AccountManager $accountManager,
93
-								ILogger $logger,
94
-								IFactory $l10nFactory,
95
-								NewUserMailHelper $newUserMailHelper) {
96
-		parent::__construct($appName, $request);
97
-
98
-		$this->userManager = $userManager;
99
-		$this->config = $config;
100
-		$this->appManager = $appManager;
101
-		$this->groupManager = $groupManager;
102
-		$this->userSession = $userSession;
103
-		$this->accountManager = $accountManager;
104
-		$this->logger = $logger;
105
-		$this->l10nFactory = $l10nFactory;
106
-		$this->newUserMailHelper = $newUserMailHelper;
107
-	}
108
-
109
-	/**
110
-	 * @NoAdminRequired
111
-	 *
112
-	 * returns a list of users
113
-	 *
114
-	 * @param string $search
115
-	 * @param int $limit
116
-	 * @param int $offset
117
-	 * @return DataResponse
118
-	 */
119
-	public function getUsers($search = '', $limit = null, $offset = null) {
120
-		$user = $this->userSession->getUser();
121
-		$users = [];
122
-
123
-		// Admin? Or SubAdmin?
124
-		$uid = $user->getUID();
125
-		$subAdminManager = $this->groupManager->getSubAdmin();
126
-		if($this->groupManager->isAdmin($uid)){
127
-			$users = $this->userManager->search($search, $limit, $offset);
128
-		} else if ($subAdminManager->isSubAdmin($user)) {
129
-			$subAdminOfGroups = $subAdminManager->getSubAdminsGroups($user);
130
-			foreach ($subAdminOfGroups as $key => $group) {
131
-				$subAdminOfGroups[$key] = $group->getGID();
132
-			}
133
-
134
-			if($offset === null) {
135
-				$offset = 0;
136
-			}
137
-
138
-			$users = [];
139
-			foreach ($subAdminOfGroups as $group) {
140
-				$users = array_merge($users, $this->groupManager->displayNamesInGroup($group, $search));
141
-			}
142
-
143
-			$users = array_slice($users, $offset, $limit);
144
-		}
145
-
146
-		$users = array_keys($users);
147
-
148
-		return new DataResponse([
149
-			'users' => $users
150
-		]);
151
-	}
152
-
153
-	/**
154
-	 * @PasswordConfirmationRequired
155
-	 * @NoAdminRequired
156
-	 *
157
-	 * @param string $userid
158
-	 * @param string $password
159
-	 * @param array $groups
160
-	 * @return DataResponse
161
-	 * @throws OCSException
162
-	 */
163
-	public function addUser($userid, $password, $groups = null) {
164
-		$user = $this->userSession->getUser();
165
-		$isAdmin = $this->groupManager->isAdmin($user->getUID());
166
-		$subAdminManager = $this->groupManager->getSubAdmin();
167
-
168
-		if($this->userManager->userExists($userid)) {
169
-			$this->logger->error('Failed addUser attempt: User already exists.', ['app' => 'ocs_api']);
170
-			throw new OCSException('User already exists', 102);
171
-		}
172
-
173
-		if(is_array($groups)) {
174
-			foreach ($groups as $group) {
175
-				if(!$this->groupManager->groupExists($group)) {
176
-					throw new OCSException('group '.$group.' does not exist', 104);
177
-				}
178
-				if(!$isAdmin && !$subAdminManager->isSubAdminofGroup($user, $this->groupManager->get($group))) {
179
-					throw new OCSException('insufficient privileges for group '. $group, 105);
180
-				}
181
-			}
182
-		} else {
183
-			if(!$isAdmin) {
184
-				throw new OCSException('no group specified (required for subadmins)', 106);
185
-			}
186
-		}
187
-
188
-		try {
189
-			$newUser = $this->userManager->createUser($userid, $password);
190
-			$this->logger->info('Successful addUser call with userid: '.$userid, ['app' => 'ocs_api']);
191
-
192
-			if (is_array($groups)) {
193
-				foreach ($groups as $group) {
194
-					$this->groupManager->get($group)->addUser($newUser);
195
-					$this->logger->info('Added userid '.$userid.' to group '.$group, ['app' => 'ocs_api']);
196
-				}
197
-			}
198
-			return new DataResponse();
199
-		} catch (\Exception $e) {
200
-			$this->logger->logException($e, [
201
-				'message' => 'Failed addUser attempt with exception.',
202
-				'level' => \OCP\Util::ERROR,
203
-				'app' => 'ocs_api',
204
-			]);
205
-			throw new OCSException('Bad request', 101);
206
-		}
207
-	}
208
-
209
-	/**
210
-	 * @NoAdminRequired
211
-	 * @NoSubAdminRequired
212
-	 *
213
-	 * gets user info
214
-	 *
215
-	 * @param string $userId
216
-	 * @return DataResponse
217
-	 * @throws OCSException
218
-	 */
219
-	public function getUser($userId) {
220
-		$data = $this->getUserData($userId);
221
-		return new DataResponse($data);
222
-	}
223
-
224
-	/**
225
-	 * @NoAdminRequired
226
-	 * @NoSubAdminRequired
227
-	 *
228
-	 * gets user info from the currently logged in user
229
-	 *
230
-	 * @return DataResponse
231
-	 * @throws OCSException
232
-	 */
233
-	public function getCurrentUser() {
234
-		$user = $this->userSession->getUser();
235
-		if ($user) {
236
-			$data =  $this->getUserData($user->getUID());
237
-			// rename "displayname" to "display-name" only for this call to keep
238
-			// the API stable.
239
-			$data['display-name'] = $data['displayname'];
240
-			unset($data['displayname']);
241
-			return new DataResponse($data);
242
-
243
-		}
244
-
245
-		throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
246
-	}
247
-
248
-	/**
249
-	 * creates a array with all user data
250
-	 *
251
-	 * @param $userId
252
-	 * @return array
253
-	 * @throws OCSException
254
-	 */
255
-	protected function getUserData($userId) {
256
-		$currentLoggedInUser = $this->userSession->getUser();
257
-
258
-		$data = [];
259
-
260
-		// Check if the target user exists
261
-		$targetUserObject = $this->userManager->get($userId);
262
-		if($targetUserObject === null) {
263
-			throw new OCSException('The requested user could not be found', \OCP\API::RESPOND_NOT_FOUND);
264
-		}
265
-
266
-		// Admin? Or SubAdmin?
267
-		if($this->groupManager->isAdmin($currentLoggedInUser->getUID())
268
-			|| $this->groupManager->getSubAdmin()->isUserAccessible($currentLoggedInUser, $targetUserObject)) {
269
-			$data['enabled'] = $this->config->getUserValue($targetUserObject->getUID(), 'core', 'enabled', 'true');
270
-		} else {
271
-			// Check they are looking up themselves
272
-			if($currentLoggedInUser->getUID() !== $targetUserObject->getUID()) {
273
-				throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
274
-			}
275
-		}
276
-
277
-		$userAccount = $this->accountManager->getUser($targetUserObject);
278
-		$groups = $this->groupManager->getUserGroups($targetUserObject);
279
-		$gids = [];
280
-		foreach ($groups as $group) {
281
-			$gids[] = $group->getDisplayName();
282
-		}
283
-
284
-		// Find the data
285
-		$data['id'] = $targetUserObject->getUID();
286
-		$data['quota'] = $this->fillStorageInfo($targetUserObject->getUID());
287
-		$data[AccountManager::PROPERTY_EMAIL] = $targetUserObject->getEMailAddress();
288
-		$data[AccountManager::PROPERTY_DISPLAYNAME] = $targetUserObject->getDisplayName();
289
-		$data[AccountManager::PROPERTY_PHONE] = $userAccount[AccountManager::PROPERTY_PHONE]['value'];
290
-		$data[AccountManager::PROPERTY_ADDRESS] = $userAccount[AccountManager::PROPERTY_ADDRESS]['value'];
291
-		$data[AccountManager::PROPERTY_WEBSITE] = $userAccount[AccountManager::PROPERTY_WEBSITE]['value'];
292
-		$data[AccountManager::PROPERTY_TWITTER] = $userAccount[AccountManager::PROPERTY_TWITTER]['value'];
293
-		$data['groups'] = $gids;
294
-		$data['language'] = $this->config->getUserValue($targetUserObject->getUID(), 'core', 'lang');
295
-
296
-		return $data;
297
-	}
298
-
299
-	/**
300
-	 * @NoAdminRequired
301
-	 * @NoSubAdminRequired
302
-	 * @PasswordConfirmationRequired
303
-	 *
304
-	 * edit users
305
-	 *
306
-	 * @param string $userId
307
-	 * @param string $key
308
-	 * @param string $value
309
-	 * @return DataResponse
310
-	 * @throws OCSException
311
-	 * @throws OCSForbiddenException
312
-	 */
313
-	public function editUser($userId, $key, $value) {
314
-		$currentLoggedInUser = $this->userSession->getUser();
315
-
316
-		$targetUser = $this->userManager->get($userId);
317
-		if($targetUser === null) {
318
-			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
319
-		}
320
-
321
-		$permittedFields = [];
322
-		if($targetUser->getUID() === $currentLoggedInUser->getUID()) {
323
-			// Editing self (display, email)
324
-			if ($this->config->getSystemValue('allow_user_to_change_display_name', true) !== false) {
325
-				$permittedFields[] = 'display';
326
-				$permittedFields[] = AccountManager::PROPERTY_DISPLAYNAME;
327
-				$permittedFields[] = AccountManager::PROPERTY_EMAIL;
328
-			}
329
-
330
-			$permittedFields[] = 'password';
331
-			if ($this->config->getSystemValue('force_language', false) === false ||
332
-				$this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
333
-				$permittedFields[] = 'language';
334
-			}
335
-
336
-			if ($this->appManager->isEnabledForUser('federatedfilesharing')) {
337
-				$federatedFileSharing = new \OCA\FederatedFileSharing\AppInfo\Application();
338
-				$shareProvider = $federatedFileSharing->getFederatedShareProvider();
339
-				if ($shareProvider->isLookupServerUploadEnabled()) {
340
-					$permittedFields[] = AccountManager::PROPERTY_PHONE;
341
-					$permittedFields[] = AccountManager::PROPERTY_ADDRESS;
342
-					$permittedFields[] = AccountManager::PROPERTY_WEBSITE;
343
-					$permittedFields[] = AccountManager::PROPERTY_TWITTER;
344
-				}
345
-			}
346
-
347
-			// If admin they can edit their own quota
348
-			if($this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
349
-				$permittedFields[] = 'quota';
350
-			}
351
-		} else {
352
-			// Check if admin / subadmin
353
-			$subAdminManager = $this->groupManager->getSubAdmin();
354
-			if($subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
355
-			|| $this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
356
-				// They have permissions over the user
357
-				$permittedFields[] = 'display';
358
-				$permittedFields[] = AccountManager::PROPERTY_DISPLAYNAME;
359
-				$permittedFields[] = AccountManager::PROPERTY_EMAIL;
360
-				$permittedFields[] = 'password';
361
-				$permittedFields[] = 'language';
362
-				$permittedFields[] = AccountManager::PROPERTY_PHONE;
363
-				$permittedFields[] = AccountManager::PROPERTY_ADDRESS;
364
-				$permittedFields[] = AccountManager::PROPERTY_WEBSITE;
365
-				$permittedFields[] = AccountManager::PROPERTY_TWITTER;
366
-				$permittedFields[] = 'quota';
367
-			} else {
368
-				// No rights
369
-				throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
370
-			}
371
-		}
372
-		// Check if permitted to edit this field
373
-		if(!in_array($key, $permittedFields)) {
374
-			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
375
-		}
376
-		// Process the edit
377
-		switch($key) {
378
-			case 'display':
379
-			case AccountManager::PROPERTY_DISPLAYNAME:
380
-				$targetUser->setDisplayName($value);
381
-				break;
382
-			case 'quota':
383
-				$quota = $value;
384
-				if($quota !== 'none' && $quota !== 'default') {
385
-					if (is_numeric($quota)) {
386
-						$quota = (float) $quota;
387
-					} else {
388
-						$quota = \OCP\Util::computerFileSize($quota);
389
-					}
390
-					if ($quota === false) {
391
-						throw new OCSException('Invalid quota value '.$value, 103);
392
-					}
393
-					if($quota === 0) {
394
-						$quota = 'default';
395
-					}else if($quota === -1) {
396
-						$quota = 'none';
397
-					} else {
398
-						$quota = \OCP\Util::humanFileSize($quota);
399
-					}
400
-				}
401
-				$targetUser->setQuota($quota);
402
-				break;
403
-			case 'password':
404
-				$targetUser->setPassword($value);
405
-				break;
406
-			case 'language':
407
-				$languagesCodes = $this->l10nFactory->findAvailableLanguages();
408
-				if (!in_array($value, $languagesCodes, true) && $value !== 'en') {
409
-					throw new OCSException('Invalid language', 102);
410
-				}
411
-				$this->config->setUserValue($targetUser->getUID(), 'core', 'lang', $value);
412
-				break;
413
-			case AccountManager::PROPERTY_EMAIL:
414
-				if(filter_var($value, FILTER_VALIDATE_EMAIL)) {
415
-					$targetUser->setEMailAddress($value);
416
-				} else {
417
-					throw new OCSException('', 102);
418
-				}
419
-				break;
420
-			case AccountManager::PROPERTY_PHONE:
421
-			case AccountManager::PROPERTY_ADDRESS:
422
-			case AccountManager::PROPERTY_WEBSITE:
423
-			case AccountManager::PROPERTY_TWITTER:
424
-				$userAccount = $this->accountManager->getUser($targetUser);
425
-				if ($userAccount[$key]['value'] !== $value) {
426
-					$userAccount[$key]['value'] = $value;
427
-					$this->accountManager->updateUser($targetUser, $userAccount);
428
-				}
429
-				break;
430
-			default:
431
-				throw new OCSException('', 103);
432
-		}
433
-		return new DataResponse();
434
-	}
435
-
436
-	/**
437
-	 * @PasswordConfirmationRequired
438
-	 * @NoAdminRequired
439
-	 *
440
-	 * @param string $userId
441
-	 * @return DataResponse
442
-	 * @throws OCSException
443
-	 * @throws OCSForbiddenException
444
-	 */
445
-	public function deleteUser($userId) {
446
-		$currentLoggedInUser = $this->userSession->getUser();
447
-
448
-		$targetUser = $this->userManager->get($userId);
449
-
450
-		if($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
451
-			throw new OCSException('', 101);
452
-		}
453
-
454
-		// If not permitted
455
-		$subAdminManager = $this->groupManager->getSubAdmin();
456
-		if(!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
457
-			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
458
-		}
459
-
460
-		// Go ahead with the delete
461
-		if($targetUser->delete()) {
462
-			return new DataResponse();
463
-		} else {
464
-			throw new OCSException('', 101);
465
-		}
466
-	}
467
-
468
-	/**
469
-	 * @PasswordConfirmationRequired
470
-	 * @NoAdminRequired
471
-	 *
472
-	 * @param string $userId
473
-	 * @return DataResponse
474
-	 * @throws OCSException
475
-	 * @throws OCSForbiddenException
476
-	 */
477
-	public function disableUser($userId) {
478
-		return $this->setEnabled($userId, false);
479
-	}
480
-
481
-	/**
482
-	 * @PasswordConfirmationRequired
483
-	 * @NoAdminRequired
484
-	 *
485
-	 * @param string $userId
486
-	 * @return DataResponse
487
-	 * @throws OCSException
488
-	 * @throws OCSForbiddenException
489
-	 */
490
-	public function enableUser($userId) {
491
-		return $this->setEnabled($userId, true);
492
-	}
493
-
494
-	/**
495
-	 * @param string $userId
496
-	 * @param bool $value
497
-	 * @return DataResponse
498
-	 * @throws OCSException
499
-	 * @throws OCSForbiddenException
500
-	 */
501
-	private function setEnabled($userId, $value) {
502
-		$currentLoggedInUser = $this->userSession->getUser();
503
-
504
-		$targetUser = $this->userManager->get($userId);
505
-		if($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
506
-			throw new OCSException('', 101);
507
-		}
508
-
509
-		// If not permitted
510
-		$subAdminManager = $this->groupManager->getSubAdmin();
511
-		if(!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
512
-			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
513
-		}
514
-
515
-		// enable/disable the user now
516
-		$targetUser->setEnabled($value);
517
-		return new DataResponse();
518
-	}
519
-
520
-	/**
521
-	 * @NoAdminRequired
522
-	 * @NoSubAdminRequired
523
-	 *
524
-	 * @param string $userId
525
-	 * @return DataResponse
526
-	 * @throws OCSException
527
-	 */
528
-	public function getUsersGroups($userId) {
529
-		$loggedInUser = $this->userSession->getUser();
530
-
531
-		$targetUser = $this->userManager->get($userId);
532
-		if($targetUser === null) {
533
-			throw new OCSException('', \OCP\API::RESPOND_NOT_FOUND);
534
-		}
535
-
536
-		if($targetUser->getUID() === $loggedInUser->getUID() || $this->groupManager->isAdmin($loggedInUser->getUID())) {
537
-			// Self lookup or admin lookup
538
-			return new DataResponse([
539
-				'groups' => $this->groupManager->getUserGroupIds($targetUser)
540
-			]);
541
-		} else {
542
-			$subAdminManager = $this->groupManager->getSubAdmin();
543
-
544
-			// Looking up someone else
545
-			if($subAdminManager->isUserAccessible($loggedInUser, $targetUser)) {
546
-				// Return the group that the method caller is subadmin of for the user in question
547
-				/** @var IGroup[] $getSubAdminsGroups */
548
-				$getSubAdminsGroups = $subAdminManager->getSubAdminsGroups($loggedInUser);
549
-				foreach ($getSubAdminsGroups as $key => $group) {
550
-					$getSubAdminsGroups[$key] = $group->getGID();
551
-				}
552
-				$groups = array_intersect(
553
-					$getSubAdminsGroups,
554
-					$this->groupManager->getUserGroupIds($targetUser)
555
-				);
556
-				return new DataResponse(['groups' => $groups]);
557
-			} else {
558
-				// Not permitted
559
-				throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
560
-			}
561
-		}
562
-
563
-	}
564
-
565
-	/**
566
-	 * @PasswordConfirmationRequired
567
-	 * @NoAdminRequired
568
-	 *
569
-	 * @param string $userId
570
-	 * @param string $groupid
571
-	 * @return DataResponse
572
-	 * @throws OCSException
573
-	 */
574
-	public function addToGroup($userId, $groupid = '') {
575
-		if($groupid === '') {
576
-			throw new OCSException('', 101);
577
-		}
578
-
579
-		$group = $this->groupManager->get($groupid);
580
-		$targetUser = $this->userManager->get($userId);
581
-		if($group === null) {
582
-			throw new OCSException('', 102);
583
-		}
584
-		if($targetUser === null) {
585
-			throw new OCSException('', 103);
586
-		}
587
-
588
-		// If they're not an admin, check they are a subadmin of the group in question
589
-		$loggedInUser = $this->userSession->getUser();
590
-		$subAdminManager = $this->groupManager->getSubAdmin();
591
-		if (!$this->groupManager->isAdmin($loggedInUser->getUID()) && !$subAdminManager->isSubAdminOfGroup($loggedInUser, $group)) {
592
-			throw new OCSException('', 104);
593
-		}
594
-
595
-		// Add user to group
596
-		$group->addUser($targetUser);
597
-		return new DataResponse();
598
-	}
599
-
600
-	/**
601
-	 * @PasswordConfirmationRequired
602
-	 * @NoAdminRequired
603
-	 *
604
-	 * @param string $userId
605
-	 * @param string $groupid
606
-	 * @return DataResponse
607
-	 * @throws OCSException
608
-	 */
609
-	public function removeFromGroup($userId, $groupid) {
610
-		$loggedInUser = $this->userSession->getUser();
611
-
612
-		if($groupid === null || trim($groupid) === '') {
613
-			throw new OCSException('', 101);
614
-		}
615
-
616
-		$group = $this->groupManager->get($groupid);
617
-		if($group === null) {
618
-			throw new OCSException('', 102);
619
-		}
620
-
621
-		$targetUser = $this->userManager->get($userId);
622
-		if($targetUser === null) {
623
-			throw new OCSException('', 103);
624
-		}
625
-
626
-		// If they're not an admin, check they are a subadmin of the group in question
627
-		$subAdminManager = $this->groupManager->getSubAdmin();
628
-		if (!$this->groupManager->isAdmin($loggedInUser->getUID()) && !$subAdminManager->isSubAdminOfGroup($loggedInUser, $group)) {
629
-			throw new OCSException('', 104);
630
-		}
631
-
632
-		// Check they aren't removing themselves from 'admin' or their 'subadmin; group
633
-		if ($targetUser->getUID() === $loggedInUser->getUID()) {
634
-			if ($this->groupManager->isAdmin($loggedInUser->getUID())) {
635
-				if ($group->getGID() === 'admin') {
636
-					throw new OCSException('Cannot remove yourself from the admin group', 105);
637
-				}
638
-			} else {
639
-				// Not an admin, so the user must be a subadmin of this group, but that is not allowed.
640
-				throw new OCSException('Cannot remove yourself from this group as you are a SubAdmin', 105);
641
-			}
642
-
643
-		} else if (!$this->groupManager->isAdmin($loggedInUser->getUID())) {
644
-			/** @var IGroup[] $subAdminGroups */
645
-			$subAdminGroups = $subAdminManager->getSubAdminsGroups($loggedInUser);
646
-			$subAdminGroups = array_map(function (IGroup $subAdminGroup) {
647
-				return $subAdminGroup->getGID();
648
-			}, $subAdminGroups);
649
-			$userGroups = $this->groupManager->getUserGroupIds($targetUser);
650
-			$userSubAdminGroups = array_intersect($subAdminGroups, $userGroups);
651
-
652
-			if (count($userSubAdminGroups) <= 1) {
653
-				// Subadmin must not be able to remove a user from all their subadmin groups.
654
-				throw new OCSException('Cannot remove user from this group as this is the only remaining group you are a SubAdmin of', 105);
655
-			}
656
-		}
657
-
658
-		// Remove user from group
659
-		$group->removeUser($targetUser);
660
-		return new DataResponse();
661
-	}
662
-
663
-	/**
664
-	 * Creates a subadmin
665
-	 *
666
-	 * @PasswordConfirmationRequired
667
-	 *
668
-	 * @param string $userId
669
-	 * @param string $groupid
670
-	 * @return DataResponse
671
-	 * @throws OCSException
672
-	 */
673
-	public function addSubAdmin($userId, $groupid) {
674
-		$group = $this->groupManager->get($groupid);
675
-		$user = $this->userManager->get($userId);
676
-
677
-		// Check if the user exists
678
-		if($user === null) {
679
-			throw new OCSException('User does not exist', 101);
680
-		}
681
-		// Check if group exists
682
-		if($group === null) {
683
-			throw new OCSException('Group does not exist',  102);
684
-		}
685
-		// Check if trying to make subadmin of admin group
686
-		if($group->getGID() === 'admin') {
687
-			throw new OCSException('Cannot create subadmins for admin group', 103);
688
-		}
689
-
690
-		$subAdminManager = $this->groupManager->getSubAdmin();
691
-
692
-		// We cannot be subadmin twice
693
-		if ($subAdminManager->isSubAdminofGroup($user, $group)) {
694
-			return new DataResponse();
695
-		}
696
-		// Go
697
-		if($subAdminManager->createSubAdmin($user, $group)) {
698
-			return new DataResponse();
699
-		} else {
700
-			throw new OCSException('Unknown error occurred', 103);
701
-		}
702
-	}
703
-
704
-	/**
705
-	 * Removes a subadmin from a group
706
-	 *
707
-	 * @PasswordConfirmationRequired
708
-	 *
709
-	 * @param string $userId
710
-	 * @param string $groupid
711
-	 * @return DataResponse
712
-	 * @throws OCSException
713
-	 */
714
-	public function removeSubAdmin($userId, $groupid) {
715
-		$group = $this->groupManager->get($groupid);
716
-		$user = $this->userManager->get($userId);
717
-		$subAdminManager = $this->groupManager->getSubAdmin();
718
-
719
-		// Check if the user exists
720
-		if($user === null) {
721
-			throw new OCSException('User does not exist', 101);
722
-		}
723
-		// Check if the group exists
724
-		if($group === null) {
725
-			throw new OCSException('Group does not exist', 101);
726
-		}
727
-		// Check if they are a subadmin of this said group
728
-		if(!$subAdminManager->isSubAdminOfGroup($user, $group)) {
729
-			throw new OCSException('User is not a subadmin of this group', 102);
730
-		}
731
-
732
-		// Go
733
-		if($subAdminManager->deleteSubAdmin($user, $group)) {
734
-			return new DataResponse();
735
-		} else {
736
-			throw new OCSException('Unknown error occurred', 103);
737
-		}
738
-	}
739
-
740
-	/**
741
-	 * Get the groups a user is a subadmin of
742
-	 *
743
-	 * @param string $userId
744
-	 * @return DataResponse
745
-	 * @throws OCSException
746
-	 */
747
-	public function getUserSubAdminGroups($userId) {
748
-		$user = $this->userManager->get($userId);
749
-		// Check if the user exists
750
-		if($user === null) {
751
-			throw new OCSException('User does not exist', 101);
752
-		}
753
-
754
-		// Get the subadmin groups
755
-		$groups = $this->groupManager->getSubAdmin()->getSubAdminsGroups($user);
756
-		foreach ($groups as $key => $group) {
757
-			$groups[$key] = $group->getGID();
758
-		}
759
-
760
-		if(!$groups) {
761
-			throw new OCSException('Unknown error occurred', 102);
762
-		} else {
763
-			return new DataResponse($groups);
764
-		}
765
-	}
766
-
767
-	/**
768
-	 * @param string $userId
769
-	 * @return array
770
-	 * @throws \OCP\Files\NotFoundException
771
-	 */
772
-	protected function fillStorageInfo($userId) {
773
-		try {
774
-			\OC_Util::tearDownFS();
775
-			\OC_Util::setupFS($userId);
776
-			$storage = OC_Helper::getStorageInfo('/');
777
-			$data = [
778
-				'free' => $storage['free'],
779
-				'used' => $storage['used'],
780
-				'total' => $storage['total'],
781
-				'relative' => $storage['relative'],
782
-				'quota' => $storage['quota'],
783
-			];
784
-		} catch (NotFoundException $ex) {
785
-			$data = [];
786
-		}
787
-		return $data;
788
-	}
789
-
790
-	/**
791
-	 * @NoAdminRequired
792
-	 * @PasswordConfirmationRequired
793
-	 *
794
-	 * resend welcome message
795
-	 *
796
-	 * @param string $userId
797
-	 * @return DataResponse
798
-	 * @throws OCSException
799
-	 */
800
-	public function resendWelcomeMessage($userId) {
801
-		$currentLoggedInUser = $this->userSession->getUser();
802
-
803
-		$targetUser = $this->userManager->get($userId);
804
-		if($targetUser === null) {
805
-			throw new OCSException('', \OCP\API::RESPOND_NOT_FOUND);
806
-		}
807
-
808
-		// Check if admin / subadmin
809
-		$subAdminManager = $this->groupManager->getSubAdmin();
810
-		if(!$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
811
-			&& !$this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
812
-			// No rights
813
-			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
814
-		}
815
-
816
-		$email = $targetUser->getEMailAddress();
817
-		if ($email === '' || $email === null) {
818
-			throw new OCSException('Email address not available', 101);
819
-		}
820
-		$username = $targetUser->getUID();
821
-		$lang = $this->config->getUserValue($username, 'core', 'lang', 'en');
822
-		if (!$this->l10nFactory->languageExists('settings', $lang)) {
823
-			$lang = 'en';
824
-		}
825
-
826
-		$l10n = $this->l10nFactory->get('settings', $lang);
827
-
828
-		try {
829
-			$this->newUserMailHelper->setL10N($l10n);
830
-			$emailTemplate = $this->newUserMailHelper->generateTemplate($targetUser, false);
831
-			$this->newUserMailHelper->sendMail($targetUser, $emailTemplate);
832
-		} catch(\Exception $e) {
833
-			$this->logger->logException($e, [
834
-				'message' => "Can't send new user mail to $email",
835
-				'level' => \OCP\Util::ERROR,
836
-				'app' => 'settings',
837
-			]);
838
-			throw new OCSException('Sending email failed', 102);
839
-		}
840
-
841
-		return new DataResponse();
842
-	}
53
+    /** @var IUserManager */
54
+    private $userManager;
55
+    /** @var IConfig */
56
+    private $config;
57
+    /** @var IAppManager */
58
+    private $appManager;
59
+    /** @var IGroupManager|\OC\Group\Manager */ // FIXME Requires a method that is not on the interface
60
+    private $groupManager;
61
+    /** @var IUserSession */
62
+    private $userSession;
63
+    /** @var AccountManager */
64
+    private $accountManager;
65
+    /** @var ILogger */
66
+    private $logger;
67
+    /** @var IFactory */
68
+    private $l10nFactory;
69
+    /** @var NewUserMailHelper */
70
+    private $newUserMailHelper;
71
+
72
+    /**
73
+     * @param string $appName
74
+     * @param IRequest $request
75
+     * @param IUserManager $userManager
76
+     * @param IConfig $config
77
+     * @param IAppManager $appManager
78
+     * @param IGroupManager $groupManager
79
+     * @param IUserSession $userSession
80
+     * @param AccountManager $accountManager
81
+     * @param ILogger $logger
82
+     * @param IFactory $l10nFactory
83
+     * @param NewUserMailHelper $newUserMailHelper
84
+     */
85
+    public function __construct($appName,
86
+                                IRequest $request,
87
+                                IUserManager $userManager,
88
+                                IConfig $config,
89
+                                IAppManager $appManager,
90
+                                IGroupManager $groupManager,
91
+                                IUserSession $userSession,
92
+                                AccountManager $accountManager,
93
+                                ILogger $logger,
94
+                                IFactory $l10nFactory,
95
+                                NewUserMailHelper $newUserMailHelper) {
96
+        parent::__construct($appName, $request);
97
+
98
+        $this->userManager = $userManager;
99
+        $this->config = $config;
100
+        $this->appManager = $appManager;
101
+        $this->groupManager = $groupManager;
102
+        $this->userSession = $userSession;
103
+        $this->accountManager = $accountManager;
104
+        $this->logger = $logger;
105
+        $this->l10nFactory = $l10nFactory;
106
+        $this->newUserMailHelper = $newUserMailHelper;
107
+    }
108
+
109
+    /**
110
+     * @NoAdminRequired
111
+     *
112
+     * returns a list of users
113
+     *
114
+     * @param string $search
115
+     * @param int $limit
116
+     * @param int $offset
117
+     * @return DataResponse
118
+     */
119
+    public function getUsers($search = '', $limit = null, $offset = null) {
120
+        $user = $this->userSession->getUser();
121
+        $users = [];
122
+
123
+        // Admin? Or SubAdmin?
124
+        $uid = $user->getUID();
125
+        $subAdminManager = $this->groupManager->getSubAdmin();
126
+        if($this->groupManager->isAdmin($uid)){
127
+            $users = $this->userManager->search($search, $limit, $offset);
128
+        } else if ($subAdminManager->isSubAdmin($user)) {
129
+            $subAdminOfGroups = $subAdminManager->getSubAdminsGroups($user);
130
+            foreach ($subAdminOfGroups as $key => $group) {
131
+                $subAdminOfGroups[$key] = $group->getGID();
132
+            }
133
+
134
+            if($offset === null) {
135
+                $offset = 0;
136
+            }
137
+
138
+            $users = [];
139
+            foreach ($subAdminOfGroups as $group) {
140
+                $users = array_merge($users, $this->groupManager->displayNamesInGroup($group, $search));
141
+            }
142
+
143
+            $users = array_slice($users, $offset, $limit);
144
+        }
145
+
146
+        $users = array_keys($users);
147
+
148
+        return new DataResponse([
149
+            'users' => $users
150
+        ]);
151
+    }
152
+
153
+    /**
154
+     * @PasswordConfirmationRequired
155
+     * @NoAdminRequired
156
+     *
157
+     * @param string $userid
158
+     * @param string $password
159
+     * @param array $groups
160
+     * @return DataResponse
161
+     * @throws OCSException
162
+     */
163
+    public function addUser($userid, $password, $groups = null) {
164
+        $user = $this->userSession->getUser();
165
+        $isAdmin = $this->groupManager->isAdmin($user->getUID());
166
+        $subAdminManager = $this->groupManager->getSubAdmin();
167
+
168
+        if($this->userManager->userExists($userid)) {
169
+            $this->logger->error('Failed addUser attempt: User already exists.', ['app' => 'ocs_api']);
170
+            throw new OCSException('User already exists', 102);
171
+        }
172
+
173
+        if(is_array($groups)) {
174
+            foreach ($groups as $group) {
175
+                if(!$this->groupManager->groupExists($group)) {
176
+                    throw new OCSException('group '.$group.' does not exist', 104);
177
+                }
178
+                if(!$isAdmin && !$subAdminManager->isSubAdminofGroup($user, $this->groupManager->get($group))) {
179
+                    throw new OCSException('insufficient privileges for group '. $group, 105);
180
+                }
181
+            }
182
+        } else {
183
+            if(!$isAdmin) {
184
+                throw new OCSException('no group specified (required for subadmins)', 106);
185
+            }
186
+        }
187
+
188
+        try {
189
+            $newUser = $this->userManager->createUser($userid, $password);
190
+            $this->logger->info('Successful addUser call with userid: '.$userid, ['app' => 'ocs_api']);
191
+
192
+            if (is_array($groups)) {
193
+                foreach ($groups as $group) {
194
+                    $this->groupManager->get($group)->addUser($newUser);
195
+                    $this->logger->info('Added userid '.$userid.' to group '.$group, ['app' => 'ocs_api']);
196
+                }
197
+            }
198
+            return new DataResponse();
199
+        } catch (\Exception $e) {
200
+            $this->logger->logException($e, [
201
+                'message' => 'Failed addUser attempt with exception.',
202
+                'level' => \OCP\Util::ERROR,
203
+                'app' => 'ocs_api',
204
+            ]);
205
+            throw new OCSException('Bad request', 101);
206
+        }
207
+    }
208
+
209
+    /**
210
+     * @NoAdminRequired
211
+     * @NoSubAdminRequired
212
+     *
213
+     * gets user info
214
+     *
215
+     * @param string $userId
216
+     * @return DataResponse
217
+     * @throws OCSException
218
+     */
219
+    public function getUser($userId) {
220
+        $data = $this->getUserData($userId);
221
+        return new DataResponse($data);
222
+    }
223
+
224
+    /**
225
+     * @NoAdminRequired
226
+     * @NoSubAdminRequired
227
+     *
228
+     * gets user info from the currently logged in user
229
+     *
230
+     * @return DataResponse
231
+     * @throws OCSException
232
+     */
233
+    public function getCurrentUser() {
234
+        $user = $this->userSession->getUser();
235
+        if ($user) {
236
+            $data =  $this->getUserData($user->getUID());
237
+            // rename "displayname" to "display-name" only for this call to keep
238
+            // the API stable.
239
+            $data['display-name'] = $data['displayname'];
240
+            unset($data['displayname']);
241
+            return new DataResponse($data);
242
+
243
+        }
244
+
245
+        throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
246
+    }
247
+
248
+    /**
249
+     * creates a array with all user data
250
+     *
251
+     * @param $userId
252
+     * @return array
253
+     * @throws OCSException
254
+     */
255
+    protected function getUserData($userId) {
256
+        $currentLoggedInUser = $this->userSession->getUser();
257
+
258
+        $data = [];
259
+
260
+        // Check if the target user exists
261
+        $targetUserObject = $this->userManager->get($userId);
262
+        if($targetUserObject === null) {
263
+            throw new OCSException('The requested user could not be found', \OCP\API::RESPOND_NOT_FOUND);
264
+        }
265
+
266
+        // Admin? Or SubAdmin?
267
+        if($this->groupManager->isAdmin($currentLoggedInUser->getUID())
268
+            || $this->groupManager->getSubAdmin()->isUserAccessible($currentLoggedInUser, $targetUserObject)) {
269
+            $data['enabled'] = $this->config->getUserValue($targetUserObject->getUID(), 'core', 'enabled', 'true');
270
+        } else {
271
+            // Check they are looking up themselves
272
+            if($currentLoggedInUser->getUID() !== $targetUserObject->getUID()) {
273
+                throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
274
+            }
275
+        }
276
+
277
+        $userAccount = $this->accountManager->getUser($targetUserObject);
278
+        $groups = $this->groupManager->getUserGroups($targetUserObject);
279
+        $gids = [];
280
+        foreach ($groups as $group) {
281
+            $gids[] = $group->getDisplayName();
282
+        }
283
+
284
+        // Find the data
285
+        $data['id'] = $targetUserObject->getUID();
286
+        $data['quota'] = $this->fillStorageInfo($targetUserObject->getUID());
287
+        $data[AccountManager::PROPERTY_EMAIL] = $targetUserObject->getEMailAddress();
288
+        $data[AccountManager::PROPERTY_DISPLAYNAME] = $targetUserObject->getDisplayName();
289
+        $data[AccountManager::PROPERTY_PHONE] = $userAccount[AccountManager::PROPERTY_PHONE]['value'];
290
+        $data[AccountManager::PROPERTY_ADDRESS] = $userAccount[AccountManager::PROPERTY_ADDRESS]['value'];
291
+        $data[AccountManager::PROPERTY_WEBSITE] = $userAccount[AccountManager::PROPERTY_WEBSITE]['value'];
292
+        $data[AccountManager::PROPERTY_TWITTER] = $userAccount[AccountManager::PROPERTY_TWITTER]['value'];
293
+        $data['groups'] = $gids;
294
+        $data['language'] = $this->config->getUserValue($targetUserObject->getUID(), 'core', 'lang');
295
+
296
+        return $data;
297
+    }
298
+
299
+    /**
300
+     * @NoAdminRequired
301
+     * @NoSubAdminRequired
302
+     * @PasswordConfirmationRequired
303
+     *
304
+     * edit users
305
+     *
306
+     * @param string $userId
307
+     * @param string $key
308
+     * @param string $value
309
+     * @return DataResponse
310
+     * @throws OCSException
311
+     * @throws OCSForbiddenException
312
+     */
313
+    public function editUser($userId, $key, $value) {
314
+        $currentLoggedInUser = $this->userSession->getUser();
315
+
316
+        $targetUser = $this->userManager->get($userId);
317
+        if($targetUser === null) {
318
+            throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
319
+        }
320
+
321
+        $permittedFields = [];
322
+        if($targetUser->getUID() === $currentLoggedInUser->getUID()) {
323
+            // Editing self (display, email)
324
+            if ($this->config->getSystemValue('allow_user_to_change_display_name', true) !== false) {
325
+                $permittedFields[] = 'display';
326
+                $permittedFields[] = AccountManager::PROPERTY_DISPLAYNAME;
327
+                $permittedFields[] = AccountManager::PROPERTY_EMAIL;
328
+            }
329
+
330
+            $permittedFields[] = 'password';
331
+            if ($this->config->getSystemValue('force_language', false) === false ||
332
+                $this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
333
+                $permittedFields[] = 'language';
334
+            }
335
+
336
+            if ($this->appManager->isEnabledForUser('federatedfilesharing')) {
337
+                $federatedFileSharing = new \OCA\FederatedFileSharing\AppInfo\Application();
338
+                $shareProvider = $federatedFileSharing->getFederatedShareProvider();
339
+                if ($shareProvider->isLookupServerUploadEnabled()) {
340
+                    $permittedFields[] = AccountManager::PROPERTY_PHONE;
341
+                    $permittedFields[] = AccountManager::PROPERTY_ADDRESS;
342
+                    $permittedFields[] = AccountManager::PROPERTY_WEBSITE;
343
+                    $permittedFields[] = AccountManager::PROPERTY_TWITTER;
344
+                }
345
+            }
346
+
347
+            // If admin they can edit their own quota
348
+            if($this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
349
+                $permittedFields[] = 'quota';
350
+            }
351
+        } else {
352
+            // Check if admin / subadmin
353
+            $subAdminManager = $this->groupManager->getSubAdmin();
354
+            if($subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
355
+            || $this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
356
+                // They have permissions over the user
357
+                $permittedFields[] = 'display';
358
+                $permittedFields[] = AccountManager::PROPERTY_DISPLAYNAME;
359
+                $permittedFields[] = AccountManager::PROPERTY_EMAIL;
360
+                $permittedFields[] = 'password';
361
+                $permittedFields[] = 'language';
362
+                $permittedFields[] = AccountManager::PROPERTY_PHONE;
363
+                $permittedFields[] = AccountManager::PROPERTY_ADDRESS;
364
+                $permittedFields[] = AccountManager::PROPERTY_WEBSITE;
365
+                $permittedFields[] = AccountManager::PROPERTY_TWITTER;
366
+                $permittedFields[] = 'quota';
367
+            } else {
368
+                // No rights
369
+                throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
370
+            }
371
+        }
372
+        // Check if permitted to edit this field
373
+        if(!in_array($key, $permittedFields)) {
374
+            throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
375
+        }
376
+        // Process the edit
377
+        switch($key) {
378
+            case 'display':
379
+            case AccountManager::PROPERTY_DISPLAYNAME:
380
+                $targetUser->setDisplayName($value);
381
+                break;
382
+            case 'quota':
383
+                $quota = $value;
384
+                if($quota !== 'none' && $quota !== 'default') {
385
+                    if (is_numeric($quota)) {
386
+                        $quota = (float) $quota;
387
+                    } else {
388
+                        $quota = \OCP\Util::computerFileSize($quota);
389
+                    }
390
+                    if ($quota === false) {
391
+                        throw new OCSException('Invalid quota value '.$value, 103);
392
+                    }
393
+                    if($quota === 0) {
394
+                        $quota = 'default';
395
+                    }else if($quota === -1) {
396
+                        $quota = 'none';
397
+                    } else {
398
+                        $quota = \OCP\Util::humanFileSize($quota);
399
+                    }
400
+                }
401
+                $targetUser->setQuota($quota);
402
+                break;
403
+            case 'password':
404
+                $targetUser->setPassword($value);
405
+                break;
406
+            case 'language':
407
+                $languagesCodes = $this->l10nFactory->findAvailableLanguages();
408
+                if (!in_array($value, $languagesCodes, true) && $value !== 'en') {
409
+                    throw new OCSException('Invalid language', 102);
410
+                }
411
+                $this->config->setUserValue($targetUser->getUID(), 'core', 'lang', $value);
412
+                break;
413
+            case AccountManager::PROPERTY_EMAIL:
414
+                if(filter_var($value, FILTER_VALIDATE_EMAIL)) {
415
+                    $targetUser->setEMailAddress($value);
416
+                } else {
417
+                    throw new OCSException('', 102);
418
+                }
419
+                break;
420
+            case AccountManager::PROPERTY_PHONE:
421
+            case AccountManager::PROPERTY_ADDRESS:
422
+            case AccountManager::PROPERTY_WEBSITE:
423
+            case AccountManager::PROPERTY_TWITTER:
424
+                $userAccount = $this->accountManager->getUser($targetUser);
425
+                if ($userAccount[$key]['value'] !== $value) {
426
+                    $userAccount[$key]['value'] = $value;
427
+                    $this->accountManager->updateUser($targetUser, $userAccount);
428
+                }
429
+                break;
430
+            default:
431
+                throw new OCSException('', 103);
432
+        }
433
+        return new DataResponse();
434
+    }
435
+
436
+    /**
437
+     * @PasswordConfirmationRequired
438
+     * @NoAdminRequired
439
+     *
440
+     * @param string $userId
441
+     * @return DataResponse
442
+     * @throws OCSException
443
+     * @throws OCSForbiddenException
444
+     */
445
+    public function deleteUser($userId) {
446
+        $currentLoggedInUser = $this->userSession->getUser();
447
+
448
+        $targetUser = $this->userManager->get($userId);
449
+
450
+        if($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
451
+            throw new OCSException('', 101);
452
+        }
453
+
454
+        // If not permitted
455
+        $subAdminManager = $this->groupManager->getSubAdmin();
456
+        if(!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
457
+            throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
458
+        }
459
+
460
+        // Go ahead with the delete
461
+        if($targetUser->delete()) {
462
+            return new DataResponse();
463
+        } else {
464
+            throw new OCSException('', 101);
465
+        }
466
+    }
467
+
468
+    /**
469
+     * @PasswordConfirmationRequired
470
+     * @NoAdminRequired
471
+     *
472
+     * @param string $userId
473
+     * @return DataResponse
474
+     * @throws OCSException
475
+     * @throws OCSForbiddenException
476
+     */
477
+    public function disableUser($userId) {
478
+        return $this->setEnabled($userId, false);
479
+    }
480
+
481
+    /**
482
+     * @PasswordConfirmationRequired
483
+     * @NoAdminRequired
484
+     *
485
+     * @param string $userId
486
+     * @return DataResponse
487
+     * @throws OCSException
488
+     * @throws OCSForbiddenException
489
+     */
490
+    public function enableUser($userId) {
491
+        return $this->setEnabled($userId, true);
492
+    }
493
+
494
+    /**
495
+     * @param string $userId
496
+     * @param bool $value
497
+     * @return DataResponse
498
+     * @throws OCSException
499
+     * @throws OCSForbiddenException
500
+     */
501
+    private function setEnabled($userId, $value) {
502
+        $currentLoggedInUser = $this->userSession->getUser();
503
+
504
+        $targetUser = $this->userManager->get($userId);
505
+        if($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
506
+            throw new OCSException('', 101);
507
+        }
508
+
509
+        // If not permitted
510
+        $subAdminManager = $this->groupManager->getSubAdmin();
511
+        if(!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
512
+            throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
513
+        }
514
+
515
+        // enable/disable the user now
516
+        $targetUser->setEnabled($value);
517
+        return new DataResponse();
518
+    }
519
+
520
+    /**
521
+     * @NoAdminRequired
522
+     * @NoSubAdminRequired
523
+     *
524
+     * @param string $userId
525
+     * @return DataResponse
526
+     * @throws OCSException
527
+     */
528
+    public function getUsersGroups($userId) {
529
+        $loggedInUser = $this->userSession->getUser();
530
+
531
+        $targetUser = $this->userManager->get($userId);
532
+        if($targetUser === null) {
533
+            throw new OCSException('', \OCP\API::RESPOND_NOT_FOUND);
534
+        }
535
+
536
+        if($targetUser->getUID() === $loggedInUser->getUID() || $this->groupManager->isAdmin($loggedInUser->getUID())) {
537
+            // Self lookup or admin lookup
538
+            return new DataResponse([
539
+                'groups' => $this->groupManager->getUserGroupIds($targetUser)
540
+            ]);
541
+        } else {
542
+            $subAdminManager = $this->groupManager->getSubAdmin();
543
+
544
+            // Looking up someone else
545
+            if($subAdminManager->isUserAccessible($loggedInUser, $targetUser)) {
546
+                // Return the group that the method caller is subadmin of for the user in question
547
+                /** @var IGroup[] $getSubAdminsGroups */
548
+                $getSubAdminsGroups = $subAdminManager->getSubAdminsGroups($loggedInUser);
549
+                foreach ($getSubAdminsGroups as $key => $group) {
550
+                    $getSubAdminsGroups[$key] = $group->getGID();
551
+                }
552
+                $groups = array_intersect(
553
+                    $getSubAdminsGroups,
554
+                    $this->groupManager->getUserGroupIds($targetUser)
555
+                );
556
+                return new DataResponse(['groups' => $groups]);
557
+            } else {
558
+                // Not permitted
559
+                throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
560
+            }
561
+        }
562
+
563
+    }
564
+
565
+    /**
566
+     * @PasswordConfirmationRequired
567
+     * @NoAdminRequired
568
+     *
569
+     * @param string $userId
570
+     * @param string $groupid
571
+     * @return DataResponse
572
+     * @throws OCSException
573
+     */
574
+    public function addToGroup($userId, $groupid = '') {
575
+        if($groupid === '') {
576
+            throw new OCSException('', 101);
577
+        }
578
+
579
+        $group = $this->groupManager->get($groupid);
580
+        $targetUser = $this->userManager->get($userId);
581
+        if($group === null) {
582
+            throw new OCSException('', 102);
583
+        }
584
+        if($targetUser === null) {
585
+            throw new OCSException('', 103);
586
+        }
587
+
588
+        // If they're not an admin, check they are a subadmin of the group in question
589
+        $loggedInUser = $this->userSession->getUser();
590
+        $subAdminManager = $this->groupManager->getSubAdmin();
591
+        if (!$this->groupManager->isAdmin($loggedInUser->getUID()) && !$subAdminManager->isSubAdminOfGroup($loggedInUser, $group)) {
592
+            throw new OCSException('', 104);
593
+        }
594
+
595
+        // Add user to group
596
+        $group->addUser($targetUser);
597
+        return new DataResponse();
598
+    }
599
+
600
+    /**
601
+     * @PasswordConfirmationRequired
602
+     * @NoAdminRequired
603
+     *
604
+     * @param string $userId
605
+     * @param string $groupid
606
+     * @return DataResponse
607
+     * @throws OCSException
608
+     */
609
+    public function removeFromGroup($userId, $groupid) {
610
+        $loggedInUser = $this->userSession->getUser();
611
+
612
+        if($groupid === null || trim($groupid) === '') {
613
+            throw new OCSException('', 101);
614
+        }
615
+
616
+        $group = $this->groupManager->get($groupid);
617
+        if($group === null) {
618
+            throw new OCSException('', 102);
619
+        }
620
+
621
+        $targetUser = $this->userManager->get($userId);
622
+        if($targetUser === null) {
623
+            throw new OCSException('', 103);
624
+        }
625
+
626
+        // If they're not an admin, check they are a subadmin of the group in question
627
+        $subAdminManager = $this->groupManager->getSubAdmin();
628
+        if (!$this->groupManager->isAdmin($loggedInUser->getUID()) && !$subAdminManager->isSubAdminOfGroup($loggedInUser, $group)) {
629
+            throw new OCSException('', 104);
630
+        }
631
+
632
+        // Check they aren't removing themselves from 'admin' or their 'subadmin; group
633
+        if ($targetUser->getUID() === $loggedInUser->getUID()) {
634
+            if ($this->groupManager->isAdmin($loggedInUser->getUID())) {
635
+                if ($group->getGID() === 'admin') {
636
+                    throw new OCSException('Cannot remove yourself from the admin group', 105);
637
+                }
638
+            } else {
639
+                // Not an admin, so the user must be a subadmin of this group, but that is not allowed.
640
+                throw new OCSException('Cannot remove yourself from this group as you are a SubAdmin', 105);
641
+            }
642
+
643
+        } else if (!$this->groupManager->isAdmin($loggedInUser->getUID())) {
644
+            /** @var IGroup[] $subAdminGroups */
645
+            $subAdminGroups = $subAdminManager->getSubAdminsGroups($loggedInUser);
646
+            $subAdminGroups = array_map(function (IGroup $subAdminGroup) {
647
+                return $subAdminGroup->getGID();
648
+            }, $subAdminGroups);
649
+            $userGroups = $this->groupManager->getUserGroupIds($targetUser);
650
+            $userSubAdminGroups = array_intersect($subAdminGroups, $userGroups);
651
+
652
+            if (count($userSubAdminGroups) <= 1) {
653
+                // Subadmin must not be able to remove a user from all their subadmin groups.
654
+                throw new OCSException('Cannot remove user from this group as this is the only remaining group you are a SubAdmin of', 105);
655
+            }
656
+        }
657
+
658
+        // Remove user from group
659
+        $group->removeUser($targetUser);
660
+        return new DataResponse();
661
+    }
662
+
663
+    /**
664
+     * Creates a subadmin
665
+     *
666
+     * @PasswordConfirmationRequired
667
+     *
668
+     * @param string $userId
669
+     * @param string $groupid
670
+     * @return DataResponse
671
+     * @throws OCSException
672
+     */
673
+    public function addSubAdmin($userId, $groupid) {
674
+        $group = $this->groupManager->get($groupid);
675
+        $user = $this->userManager->get($userId);
676
+
677
+        // Check if the user exists
678
+        if($user === null) {
679
+            throw new OCSException('User does not exist', 101);
680
+        }
681
+        // Check if group exists
682
+        if($group === null) {
683
+            throw new OCSException('Group does not exist',  102);
684
+        }
685
+        // Check if trying to make subadmin of admin group
686
+        if($group->getGID() === 'admin') {
687
+            throw new OCSException('Cannot create subadmins for admin group', 103);
688
+        }
689
+
690
+        $subAdminManager = $this->groupManager->getSubAdmin();
691
+
692
+        // We cannot be subadmin twice
693
+        if ($subAdminManager->isSubAdminofGroup($user, $group)) {
694
+            return new DataResponse();
695
+        }
696
+        // Go
697
+        if($subAdminManager->createSubAdmin($user, $group)) {
698
+            return new DataResponse();
699
+        } else {
700
+            throw new OCSException('Unknown error occurred', 103);
701
+        }
702
+    }
703
+
704
+    /**
705
+     * Removes a subadmin from a group
706
+     *
707
+     * @PasswordConfirmationRequired
708
+     *
709
+     * @param string $userId
710
+     * @param string $groupid
711
+     * @return DataResponse
712
+     * @throws OCSException
713
+     */
714
+    public function removeSubAdmin($userId, $groupid) {
715
+        $group = $this->groupManager->get($groupid);
716
+        $user = $this->userManager->get($userId);
717
+        $subAdminManager = $this->groupManager->getSubAdmin();
718
+
719
+        // Check if the user exists
720
+        if($user === null) {
721
+            throw new OCSException('User does not exist', 101);
722
+        }
723
+        // Check if the group exists
724
+        if($group === null) {
725
+            throw new OCSException('Group does not exist', 101);
726
+        }
727
+        // Check if they are a subadmin of this said group
728
+        if(!$subAdminManager->isSubAdminOfGroup($user, $group)) {
729
+            throw new OCSException('User is not a subadmin of this group', 102);
730
+        }
731
+
732
+        // Go
733
+        if($subAdminManager->deleteSubAdmin($user, $group)) {
734
+            return new DataResponse();
735
+        } else {
736
+            throw new OCSException('Unknown error occurred', 103);
737
+        }
738
+    }
739
+
740
+    /**
741
+     * Get the groups a user is a subadmin of
742
+     *
743
+     * @param string $userId
744
+     * @return DataResponse
745
+     * @throws OCSException
746
+     */
747
+    public function getUserSubAdminGroups($userId) {
748
+        $user = $this->userManager->get($userId);
749
+        // Check if the user exists
750
+        if($user === null) {
751
+            throw new OCSException('User does not exist', 101);
752
+        }
753
+
754
+        // Get the subadmin groups
755
+        $groups = $this->groupManager->getSubAdmin()->getSubAdminsGroups($user);
756
+        foreach ($groups as $key => $group) {
757
+            $groups[$key] = $group->getGID();
758
+        }
759
+
760
+        if(!$groups) {
761
+            throw new OCSException('Unknown error occurred', 102);
762
+        } else {
763
+            return new DataResponse($groups);
764
+        }
765
+    }
766
+
767
+    /**
768
+     * @param string $userId
769
+     * @return array
770
+     * @throws \OCP\Files\NotFoundException
771
+     */
772
+    protected function fillStorageInfo($userId) {
773
+        try {
774
+            \OC_Util::tearDownFS();
775
+            \OC_Util::setupFS($userId);
776
+            $storage = OC_Helper::getStorageInfo('/');
777
+            $data = [
778
+                'free' => $storage['free'],
779
+                'used' => $storage['used'],
780
+                'total' => $storage['total'],
781
+                'relative' => $storage['relative'],
782
+                'quota' => $storage['quota'],
783
+            ];
784
+        } catch (NotFoundException $ex) {
785
+            $data = [];
786
+        }
787
+        return $data;
788
+    }
789
+
790
+    /**
791
+     * @NoAdminRequired
792
+     * @PasswordConfirmationRequired
793
+     *
794
+     * resend welcome message
795
+     *
796
+     * @param string $userId
797
+     * @return DataResponse
798
+     * @throws OCSException
799
+     */
800
+    public function resendWelcomeMessage($userId) {
801
+        $currentLoggedInUser = $this->userSession->getUser();
802
+
803
+        $targetUser = $this->userManager->get($userId);
804
+        if($targetUser === null) {
805
+            throw new OCSException('', \OCP\API::RESPOND_NOT_FOUND);
806
+        }
807
+
808
+        // Check if admin / subadmin
809
+        $subAdminManager = $this->groupManager->getSubAdmin();
810
+        if(!$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
811
+            && !$this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
812
+            // No rights
813
+            throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
814
+        }
815
+
816
+        $email = $targetUser->getEMailAddress();
817
+        if ($email === '' || $email === null) {
818
+            throw new OCSException('Email address not available', 101);
819
+        }
820
+        $username = $targetUser->getUID();
821
+        $lang = $this->config->getUserValue($username, 'core', 'lang', 'en');
822
+        if (!$this->l10nFactory->languageExists('settings', $lang)) {
823
+            $lang = 'en';
824
+        }
825
+
826
+        $l10n = $this->l10nFactory->get('settings', $lang);
827
+
828
+        try {
829
+            $this->newUserMailHelper->setL10N($l10n);
830
+            $emailTemplate = $this->newUserMailHelper->generateTemplate($targetUser, false);
831
+            $this->newUserMailHelper->sendMail($targetUser, $emailTemplate);
832
+        } catch(\Exception $e) {
833
+            $this->logger->logException($e, [
834
+                'message' => "Can't send new user mail to $email",
835
+                'level' => \OCP\Util::ERROR,
836
+                'app' => 'settings',
837
+            ]);
838
+            throw new OCSException('Sending email failed', 102);
839
+        }
840
+
841
+        return new DataResponse();
842
+    }
843 843
 }
Please login to merge, or discard this patch.
Spacing   +51 added lines, -51 removed lines patch added patch discarded remove patch
@@ -123,7 +123,7 @@  discard block
 block discarded – undo
123 123
 		// Admin? Or SubAdmin?
124 124
 		$uid = $user->getUID();
125 125
 		$subAdminManager = $this->groupManager->getSubAdmin();
126
-		if($this->groupManager->isAdmin($uid)){
126
+		if ($this->groupManager->isAdmin($uid)) {
127 127
 			$users = $this->userManager->search($search, $limit, $offset);
128 128
 		} else if ($subAdminManager->isSubAdmin($user)) {
129 129
 			$subAdminOfGroups = $subAdminManager->getSubAdminsGroups($user);
@@ -131,7 +131,7 @@  discard block
 block discarded – undo
131 131
 				$subAdminOfGroups[$key] = $group->getGID();
132 132
 			}
133 133
 
134
-			if($offset === null) {
134
+			if ($offset === null) {
135 135
 				$offset = 0;
136 136
 			}
137 137
 
@@ -165,22 +165,22 @@  discard block
 block discarded – undo
165 165
 		$isAdmin = $this->groupManager->isAdmin($user->getUID());
166 166
 		$subAdminManager = $this->groupManager->getSubAdmin();
167 167
 
168
-		if($this->userManager->userExists($userid)) {
168
+		if ($this->userManager->userExists($userid)) {
169 169
 			$this->logger->error('Failed addUser attempt: User already exists.', ['app' => 'ocs_api']);
170 170
 			throw new OCSException('User already exists', 102);
171 171
 		}
172 172
 
173
-		if(is_array($groups)) {
173
+		if (is_array($groups)) {
174 174
 			foreach ($groups as $group) {
175
-				if(!$this->groupManager->groupExists($group)) {
175
+				if (!$this->groupManager->groupExists($group)) {
176 176
 					throw new OCSException('group '.$group.' does not exist', 104);
177 177
 				}
178
-				if(!$isAdmin && !$subAdminManager->isSubAdminofGroup($user, $this->groupManager->get($group))) {
179
-					throw new OCSException('insufficient privileges for group '. $group, 105);
178
+				if (!$isAdmin && !$subAdminManager->isSubAdminofGroup($user, $this->groupManager->get($group))) {
179
+					throw new OCSException('insufficient privileges for group '.$group, 105);
180 180
 				}
181 181
 			}
182 182
 		} else {
183
-			if(!$isAdmin) {
183
+			if (!$isAdmin) {
184 184
 				throw new OCSException('no group specified (required for subadmins)', 106);
185 185
 			}
186 186
 		}
@@ -233,7 +233,7 @@  discard block
 block discarded – undo
233 233
 	public function getCurrentUser() {
234 234
 		$user = $this->userSession->getUser();
235 235
 		if ($user) {
236
-			$data =  $this->getUserData($user->getUID());
236
+			$data = $this->getUserData($user->getUID());
237 237
 			// rename "displayname" to "display-name" only for this call to keep
238 238
 			// the API stable.
239 239
 			$data['display-name'] = $data['displayname'];
@@ -259,17 +259,17 @@  discard block
 block discarded – undo
259 259
 
260 260
 		// Check if the target user exists
261 261
 		$targetUserObject = $this->userManager->get($userId);
262
-		if($targetUserObject === null) {
262
+		if ($targetUserObject === null) {
263 263
 			throw new OCSException('The requested user could not be found', \OCP\API::RESPOND_NOT_FOUND);
264 264
 		}
265 265
 
266 266
 		// Admin? Or SubAdmin?
267
-		if($this->groupManager->isAdmin($currentLoggedInUser->getUID())
267
+		if ($this->groupManager->isAdmin($currentLoggedInUser->getUID())
268 268
 			|| $this->groupManager->getSubAdmin()->isUserAccessible($currentLoggedInUser, $targetUserObject)) {
269 269
 			$data['enabled'] = $this->config->getUserValue($targetUserObject->getUID(), 'core', 'enabled', 'true');
270 270
 		} else {
271 271
 			// Check they are looking up themselves
272
-			if($currentLoggedInUser->getUID() !== $targetUserObject->getUID()) {
272
+			if ($currentLoggedInUser->getUID() !== $targetUserObject->getUID()) {
273 273
 				throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
274 274
 			}
275 275
 		}
@@ -314,12 +314,12 @@  discard block
 block discarded – undo
314 314
 		$currentLoggedInUser = $this->userSession->getUser();
315 315
 
316 316
 		$targetUser = $this->userManager->get($userId);
317
-		if($targetUser === null) {
317
+		if ($targetUser === null) {
318 318
 			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
319 319
 		}
320 320
 
321 321
 		$permittedFields = [];
322
-		if($targetUser->getUID() === $currentLoggedInUser->getUID()) {
322
+		if ($targetUser->getUID() === $currentLoggedInUser->getUID()) {
323 323
 			// Editing self (display, email)
324 324
 			if ($this->config->getSystemValue('allow_user_to_change_display_name', true) !== false) {
325 325
 				$permittedFields[] = 'display';
@@ -345,13 +345,13 @@  discard block
 block discarded – undo
345 345
 			}
346 346
 
347 347
 			// If admin they can edit their own quota
348
-			if($this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
348
+			if ($this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
349 349
 				$permittedFields[] = 'quota';
350 350
 			}
351 351
 		} else {
352 352
 			// Check if admin / subadmin
353 353
 			$subAdminManager = $this->groupManager->getSubAdmin();
354
-			if($subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
354
+			if ($subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
355 355
 			|| $this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
356 356
 				// They have permissions over the user
357 357
 				$permittedFields[] = 'display';
@@ -370,18 +370,18 @@  discard block
 block discarded – undo
370 370
 			}
371 371
 		}
372 372
 		// Check if permitted to edit this field
373
-		if(!in_array($key, $permittedFields)) {
373
+		if (!in_array($key, $permittedFields)) {
374 374
 			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
375 375
 		}
376 376
 		// Process the edit
377
-		switch($key) {
377
+		switch ($key) {
378 378
 			case 'display':
379 379
 			case AccountManager::PROPERTY_DISPLAYNAME:
380 380
 				$targetUser->setDisplayName($value);
381 381
 				break;
382 382
 			case 'quota':
383 383
 				$quota = $value;
384
-				if($quota !== 'none' && $quota !== 'default') {
384
+				if ($quota !== 'none' && $quota !== 'default') {
385 385
 					if (is_numeric($quota)) {
386 386
 						$quota = (float) $quota;
387 387
 					} else {
@@ -390,9 +390,9 @@  discard block
 block discarded – undo
390 390
 					if ($quota === false) {
391 391
 						throw new OCSException('Invalid quota value '.$value, 103);
392 392
 					}
393
-					if($quota === 0) {
393
+					if ($quota === 0) {
394 394
 						$quota = 'default';
395
-					}else if($quota === -1) {
395
+					} else if ($quota === -1) {
396 396
 						$quota = 'none';
397 397
 					} else {
398 398
 						$quota = \OCP\Util::humanFileSize($quota);
@@ -411,7 +411,7 @@  discard block
 block discarded – undo
411 411
 				$this->config->setUserValue($targetUser->getUID(), 'core', 'lang', $value);
412 412
 				break;
413 413
 			case AccountManager::PROPERTY_EMAIL:
414
-				if(filter_var($value, FILTER_VALIDATE_EMAIL)) {
414
+				if (filter_var($value, FILTER_VALIDATE_EMAIL)) {
415 415
 					$targetUser->setEMailAddress($value);
416 416
 				} else {
417 417
 					throw new OCSException('', 102);
@@ -447,18 +447,18 @@  discard block
 block discarded – undo
447 447
 
448 448
 		$targetUser = $this->userManager->get($userId);
449 449
 
450
-		if($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
450
+		if ($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
451 451
 			throw new OCSException('', 101);
452 452
 		}
453 453
 
454 454
 		// If not permitted
455 455
 		$subAdminManager = $this->groupManager->getSubAdmin();
456
-		if(!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
456
+		if (!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
457 457
 			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
458 458
 		}
459 459
 
460 460
 		// Go ahead with the delete
461
-		if($targetUser->delete()) {
461
+		if ($targetUser->delete()) {
462 462
 			return new DataResponse();
463 463
 		} else {
464 464
 			throw new OCSException('', 101);
@@ -502,13 +502,13 @@  discard block
 block discarded – undo
502 502
 		$currentLoggedInUser = $this->userSession->getUser();
503 503
 
504 504
 		$targetUser = $this->userManager->get($userId);
505
-		if($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
505
+		if ($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
506 506
 			throw new OCSException('', 101);
507 507
 		}
508 508
 
509 509
 		// If not permitted
510 510
 		$subAdminManager = $this->groupManager->getSubAdmin();
511
-		if(!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
511
+		if (!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
512 512
 			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
513 513
 		}
514 514
 
@@ -529,11 +529,11 @@  discard block
 block discarded – undo
529 529
 		$loggedInUser = $this->userSession->getUser();
530 530
 
531 531
 		$targetUser = $this->userManager->get($userId);
532
-		if($targetUser === null) {
532
+		if ($targetUser === null) {
533 533
 			throw new OCSException('', \OCP\API::RESPOND_NOT_FOUND);
534 534
 		}
535 535
 
536
-		if($targetUser->getUID() === $loggedInUser->getUID() || $this->groupManager->isAdmin($loggedInUser->getUID())) {
536
+		if ($targetUser->getUID() === $loggedInUser->getUID() || $this->groupManager->isAdmin($loggedInUser->getUID())) {
537 537
 			// Self lookup or admin lookup
538 538
 			return new DataResponse([
539 539
 				'groups' => $this->groupManager->getUserGroupIds($targetUser)
@@ -542,7 +542,7 @@  discard block
 block discarded – undo
542 542
 			$subAdminManager = $this->groupManager->getSubAdmin();
543 543
 
544 544
 			// Looking up someone else
545
-			if($subAdminManager->isUserAccessible($loggedInUser, $targetUser)) {
545
+			if ($subAdminManager->isUserAccessible($loggedInUser, $targetUser)) {
546 546
 				// Return the group that the method caller is subadmin of for the user in question
547 547
 				/** @var IGroup[] $getSubAdminsGroups */
548 548
 				$getSubAdminsGroups = $subAdminManager->getSubAdminsGroups($loggedInUser);
@@ -572,16 +572,16 @@  discard block
 block discarded – undo
572 572
 	 * @throws OCSException
573 573
 	 */
574 574
 	public function addToGroup($userId, $groupid = '') {
575
-		if($groupid === '') {
575
+		if ($groupid === '') {
576 576
 			throw new OCSException('', 101);
577 577
 		}
578 578
 
579 579
 		$group = $this->groupManager->get($groupid);
580 580
 		$targetUser = $this->userManager->get($userId);
581
-		if($group === null) {
581
+		if ($group === null) {
582 582
 			throw new OCSException('', 102);
583 583
 		}
584
-		if($targetUser === null) {
584
+		if ($targetUser === null) {
585 585
 			throw new OCSException('', 103);
586 586
 		}
587 587
 
@@ -609,17 +609,17 @@  discard block
 block discarded – undo
609 609
 	public function removeFromGroup($userId, $groupid) {
610 610
 		$loggedInUser = $this->userSession->getUser();
611 611
 
612
-		if($groupid === null || trim($groupid) === '') {
612
+		if ($groupid === null || trim($groupid) === '') {
613 613
 			throw new OCSException('', 101);
614 614
 		}
615 615
 
616 616
 		$group = $this->groupManager->get($groupid);
617
-		if($group === null) {
617
+		if ($group === null) {
618 618
 			throw new OCSException('', 102);
619 619
 		}
620 620
 
621 621
 		$targetUser = $this->userManager->get($userId);
622
-		if($targetUser === null) {
622
+		if ($targetUser === null) {
623 623
 			throw new OCSException('', 103);
624 624
 		}
625 625
 
@@ -643,7 +643,7 @@  discard block
 block discarded – undo
643 643
 		} else if (!$this->groupManager->isAdmin($loggedInUser->getUID())) {
644 644
 			/** @var IGroup[] $subAdminGroups */
645 645
 			$subAdminGroups = $subAdminManager->getSubAdminsGroups($loggedInUser);
646
-			$subAdminGroups = array_map(function (IGroup $subAdminGroup) {
646
+			$subAdminGroups = array_map(function(IGroup $subAdminGroup) {
647 647
 				return $subAdminGroup->getGID();
648 648
 			}, $subAdminGroups);
649 649
 			$userGroups = $this->groupManager->getUserGroupIds($targetUser);
@@ -675,15 +675,15 @@  discard block
 block discarded – undo
675 675
 		$user = $this->userManager->get($userId);
676 676
 
677 677
 		// Check if the user exists
678
-		if($user === null) {
678
+		if ($user === null) {
679 679
 			throw new OCSException('User does not exist', 101);
680 680
 		}
681 681
 		// Check if group exists
682
-		if($group === null) {
683
-			throw new OCSException('Group does not exist',  102);
682
+		if ($group === null) {
683
+			throw new OCSException('Group does not exist', 102);
684 684
 		}
685 685
 		// Check if trying to make subadmin of admin group
686
-		if($group->getGID() === 'admin') {
686
+		if ($group->getGID() === 'admin') {
687 687
 			throw new OCSException('Cannot create subadmins for admin group', 103);
688 688
 		}
689 689
 
@@ -694,7 +694,7 @@  discard block
 block discarded – undo
694 694
 			return new DataResponse();
695 695
 		}
696 696
 		// Go
697
-		if($subAdminManager->createSubAdmin($user, $group)) {
697
+		if ($subAdminManager->createSubAdmin($user, $group)) {
698 698
 			return new DataResponse();
699 699
 		} else {
700 700
 			throw new OCSException('Unknown error occurred', 103);
@@ -717,20 +717,20 @@  discard block
 block discarded – undo
717 717
 		$subAdminManager = $this->groupManager->getSubAdmin();
718 718
 
719 719
 		// Check if the user exists
720
-		if($user === null) {
720
+		if ($user === null) {
721 721
 			throw new OCSException('User does not exist', 101);
722 722
 		}
723 723
 		// Check if the group exists
724
-		if($group === null) {
724
+		if ($group === null) {
725 725
 			throw new OCSException('Group does not exist', 101);
726 726
 		}
727 727
 		// Check if they are a subadmin of this said group
728
-		if(!$subAdminManager->isSubAdminOfGroup($user, $group)) {
728
+		if (!$subAdminManager->isSubAdminOfGroup($user, $group)) {
729 729
 			throw new OCSException('User is not a subadmin of this group', 102);
730 730
 		}
731 731
 
732 732
 		// Go
733
-		if($subAdminManager->deleteSubAdmin($user, $group)) {
733
+		if ($subAdminManager->deleteSubAdmin($user, $group)) {
734 734
 			return new DataResponse();
735 735
 		} else {
736 736
 			throw new OCSException('Unknown error occurred', 103);
@@ -747,7 +747,7 @@  discard block
 block discarded – undo
747 747
 	public function getUserSubAdminGroups($userId) {
748 748
 		$user = $this->userManager->get($userId);
749 749
 		// Check if the user exists
750
-		if($user === null) {
750
+		if ($user === null) {
751 751
 			throw new OCSException('User does not exist', 101);
752 752
 		}
753 753
 
@@ -757,7 +757,7 @@  discard block
 block discarded – undo
757 757
 			$groups[$key] = $group->getGID();
758 758
 		}
759 759
 
760
-		if(!$groups) {
760
+		if (!$groups) {
761 761
 			throw new OCSException('Unknown error occurred', 102);
762 762
 		} else {
763 763
 			return new DataResponse($groups);
@@ -801,13 +801,13 @@  discard block
 block discarded – undo
801 801
 		$currentLoggedInUser = $this->userSession->getUser();
802 802
 
803 803
 		$targetUser = $this->userManager->get($userId);
804
-		if($targetUser === null) {
804
+		if ($targetUser === null) {
805 805
 			throw new OCSException('', \OCP\API::RESPOND_NOT_FOUND);
806 806
 		}
807 807
 
808 808
 		// Check if admin / subadmin
809 809
 		$subAdminManager = $this->groupManager->getSubAdmin();
810
-		if(!$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
810
+		if (!$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
811 811
 			&& !$this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
812 812
 			// No rights
813 813
 			throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
@@ -829,7 +829,7 @@  discard block
 block discarded – undo
829 829
 			$this->newUserMailHelper->setL10N($l10n);
830 830
 			$emailTemplate = $this->newUserMailHelper->generateTemplate($targetUser, false);
831 831
 			$this->newUserMailHelper->sendMail($targetUser, $emailTemplate);
832
-		} catch(\Exception $e) {
832
+		} catch (\Exception $e) {
833 833
 			$this->logger->logException($e, [
834 834
 				'message' => "Can't send new user mail to $email",
835 835
 				'level' => \OCP\Util::ERROR,
Please login to merge, or discard this patch.
lib/private/Files/Cache/Wrapper/CacheJail.php 3 patches
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -194,6 +194,9 @@
 block discarded – undo
194 194
 		return $this->getCache()->getStatus($this->getSourcePath($file));
195 195
 	}
196 196
 
197
+	/**
198
+	 * @param ICacheEntry[] $results
199
+	 */
197 200
 	private function formatSearchResults($results) {
198 201
 		$results = array_filter($results, array($this, 'filterCacheEntry'));
199 202
 		$results = array_values($results);
Please login to merge, or discard this patch.
Indentation   +294 added lines, -294 removed lines patch added patch discarded remove patch
@@ -36,298 +36,298 @@
 block discarded – undo
36 36
  * Jail to a subdirectory of the wrapped cache
37 37
  */
38 38
 class CacheJail extends CacheWrapper {
39
-	/**
40
-	 * @var string
41
-	 */
42
-	protected $root;
43
-
44
-	/**
45
-	 * @param \OCP\Files\Cache\ICache $cache
46
-	 * @param string $root
47
-	 */
48
-	public function __construct($cache, $root) {
49
-		parent::__construct($cache);
50
-		$this->root = $root;
51
-	}
52
-
53
-	protected function getRoot() {
54
-		return $this->root;
55
-	}
56
-
57
-	protected function getSourcePath($path) {
58
-		if ($path === '') {
59
-			return $this->getRoot();
60
-		} else {
61
-			return $this->getRoot() . '/' . ltrim($path, '/');
62
-		}
63
-	}
64
-
65
-	/**
66
-	 * @param string $path
67
-	 * @return null|string the jailed path or null if the path is outside the jail
68
-	 */
69
-	protected function getJailedPath($path) {
70
-		if ($this->getRoot() === '') {
71
-			return $path;
72
-		}
73
-		$rootLength = strlen($this->getRoot()) + 1;
74
-		if ($path === $this->getRoot()) {
75
-			return '';
76
-		} else if (substr($path, 0, $rootLength) === $this->getRoot() . '/') {
77
-			return substr($path, $rootLength);
78
-		} else {
79
-			return null;
80
-		}
81
-	}
82
-
83
-	/**
84
-	 * @param ICacheEntry|array $entry
85
-	 * @return array
86
-	 */
87
-	protected function formatCacheEntry($entry) {
88
-		if (isset($entry['path'])) {
89
-			$entry['path'] = $this->getJailedPath($entry['path']);
90
-		}
91
-		return $entry;
92
-	}
93
-
94
-	protected function filterCacheEntry($entry) {
95
-		$rootLength = strlen($this->getRoot()) + 1;
96
-		return ($entry['path'] === $this->getRoot()) or (substr($entry['path'], 0, $rootLength) === $this->getRoot() . '/');
97
-	}
98
-
99
-	/**
100
-	 * get the stored metadata of a file or folder
101
-	 *
102
-	 * @param string /int $file
103
-	 * @return ICacheEntry|false
104
-	 */
105
-	public function get($file) {
106
-		if (is_string($file) or $file == '') {
107
-			$file = $this->getSourcePath($file);
108
-		}
109
-		return parent::get($file);
110
-	}
111
-
112
-	/**
113
-	 * insert meta data for a new file or folder
114
-	 *
115
-	 * @param string $file
116
-	 * @param array $data
117
-	 *
118
-	 * @return int file id
119
-	 * @throws \RuntimeException
120
-	 */
121
-	public function insert($file, array $data) {
122
-		return $this->getCache()->insert($this->getSourcePath($file), $data);
123
-	}
124
-
125
-	/**
126
-	 * update the metadata in the cache
127
-	 *
128
-	 * @param int $id
129
-	 * @param array $data
130
-	 */
131
-	public function update($id, array $data) {
132
-		$this->getCache()->update($id, $data);
133
-	}
134
-
135
-	/**
136
-	 * get the file id for a file
137
-	 *
138
-	 * @param string $file
139
-	 * @return int
140
-	 */
141
-	public function getId($file) {
142
-		return $this->getCache()->getId($this->getSourcePath($file));
143
-	}
144
-
145
-	/**
146
-	 * get the id of the parent folder of a file
147
-	 *
148
-	 * @param string $file
149
-	 * @return int
150
-	 */
151
-	public function getParentId($file) {
152
-		return $this->getCache()->getParentId($this->getSourcePath($file));
153
-	}
154
-
155
-	/**
156
-	 * check if a file is available in the cache
157
-	 *
158
-	 * @param string $file
159
-	 * @return bool
160
-	 */
161
-	public function inCache($file) {
162
-		return $this->getCache()->inCache($this->getSourcePath($file));
163
-	}
164
-
165
-	/**
166
-	 * remove a file or folder from the cache
167
-	 *
168
-	 * @param string $file
169
-	 */
170
-	public function remove($file) {
171
-		$this->getCache()->remove($this->getSourcePath($file));
172
-	}
173
-
174
-	/**
175
-	 * Move a file or folder in the cache
176
-	 *
177
-	 * @param string $source
178
-	 * @param string $target
179
-	 */
180
-	public function move($source, $target) {
181
-		$this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target));
182
-	}
183
-
184
-	/**
185
-	 * Get the storage id and path needed for a move
186
-	 *
187
-	 * @param string $path
188
-	 * @return array [$storageId, $internalPath]
189
-	 */
190
-	protected function getMoveInfo($path) {
191
-		return [$this->getNumericStorageId(), $this->getSourcePath($path)];
192
-	}
193
-
194
-	/**
195
-	 * remove all entries for files that are stored on the storage from the cache
196
-	 */
197
-	public function clear() {
198
-		$this->getCache()->remove($this->getRoot());
199
-	}
200
-
201
-	/**
202
-	 * @param string $file
203
-	 *
204
-	 * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE
205
-	 */
206
-	public function getStatus($file) {
207
-		return $this->getCache()->getStatus($this->getSourcePath($file));
208
-	}
209
-
210
-	private function formatSearchResults($results) {
211
-		$results = array_filter($results, array($this, 'filterCacheEntry'));
212
-		$results = array_values($results);
213
-		return array_map(array($this, 'formatCacheEntry'), $results);
214
-	}
215
-
216
-	/**
217
-	 * search for files matching $pattern
218
-	 *
219
-	 * @param string $pattern
220
-	 * @return array an array of file data
221
-	 */
222
-	public function search($pattern) {
223
-		$results = $this->getCache()->search($pattern);
224
-		return $this->formatSearchResults($results);
225
-	}
226
-
227
-	/**
228
-	 * search for files by mimetype
229
-	 *
230
-	 * @param string $mimetype
231
-	 * @return array
232
-	 */
233
-	public function searchByMime($mimetype) {
234
-		$results = $this->getCache()->searchByMime($mimetype);
235
-		return $this->formatSearchResults($results);
236
-	}
237
-
238
-	public function searchQuery(ISearchQuery $query) {
239
-		$results = $this->getCache()->searchQuery($query);
240
-		return $this->formatSearchResults($results);
241
-	}
242
-
243
-	/**
244
-	 * search for files by mimetype
245
-	 *
246
-	 * @param string|int $tag name or tag id
247
-	 * @param string $userId owner of the tags
248
-	 * @return array
249
-	 */
250
-	public function searchByTag($tag, $userId) {
251
-		$results = $this->getCache()->searchByTag($tag, $userId);
252
-		return $this->formatSearchResults($results);
253
-	}
254
-
255
-	/**
256
-	 * update the folder size and the size of all parent folders
257
-	 *
258
-	 * @param string|boolean $path
259
-	 * @param array $data (optional) meta data of the folder
260
-	 */
261
-	public function correctFolderSize($path, $data = null) {
262
-		if ($this->getCache() instanceof Cache) {
263
-			$this->getCache()->correctFolderSize($this->getSourcePath($path), $data);
264
-		}
265
-	}
266
-
267
-	/**
268
-	 * get the size of a folder and set it in the cache
269
-	 *
270
-	 * @param string $path
271
-	 * @param array $entry (optional) meta data of the folder
272
-	 * @return int
273
-	 */
274
-	public function calculateFolderSize($path, $entry = null) {
275
-		if ($this->getCache() instanceof Cache) {
276
-			return $this->getCache()->calculateFolderSize($this->getSourcePath($path), $entry);
277
-		} else {
278
-			return 0;
279
-		}
280
-
281
-	}
282
-
283
-	/**
284
-	 * get all file ids on the files on the storage
285
-	 *
286
-	 * @return int[]
287
-	 */
288
-	public function getAll() {
289
-		// not supported
290
-		return array();
291
-	}
292
-
293
-	/**
294
-	 * find a folder in the cache which has not been fully scanned
295
-	 *
296
-	 * If multiply incomplete folders are in the cache, the one with the highest id will be returned,
297
-	 * use the one with the highest id gives the best result with the background scanner, since that is most
298
-	 * likely the folder where we stopped scanning previously
299
-	 *
300
-	 * @return string|bool the path of the folder or false when no folder matched
301
-	 */
302
-	public function getIncomplete() {
303
-		// not supported
304
-		return false;
305
-	}
306
-
307
-	/**
308
-	 * get the path of a file on this storage by it's id
309
-	 *
310
-	 * @param int $id
311
-	 * @return string|null
312
-	 */
313
-	public function getPathById($id) {
314
-		$path = $this->getCache()->getPathById($id);
315
-		return $this->getJailedPath($path);
316
-	}
317
-
318
-	/**
319
-	 * Move a file or folder in the cache
320
-	 *
321
-	 * Note that this should make sure the entries are removed from the source cache
322
-	 *
323
-	 * @param \OCP\Files\Cache\ICache $sourceCache
324
-	 * @param string $sourcePath
325
-	 * @param string $targetPath
326
-	 */
327
-	public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) {
328
-		if ($sourceCache === $this) {
329
-			return $this->move($sourcePath, $targetPath);
330
-		}
331
-		return $this->getCache()->moveFromCache($sourceCache, $sourcePath, $this->getSourcePath($targetPath));
332
-	}
39
+    /**
40
+     * @var string
41
+     */
42
+    protected $root;
43
+
44
+    /**
45
+     * @param \OCP\Files\Cache\ICache $cache
46
+     * @param string $root
47
+     */
48
+    public function __construct($cache, $root) {
49
+        parent::__construct($cache);
50
+        $this->root = $root;
51
+    }
52
+
53
+    protected function getRoot() {
54
+        return $this->root;
55
+    }
56
+
57
+    protected function getSourcePath($path) {
58
+        if ($path === '') {
59
+            return $this->getRoot();
60
+        } else {
61
+            return $this->getRoot() . '/' . ltrim($path, '/');
62
+        }
63
+    }
64
+
65
+    /**
66
+     * @param string $path
67
+     * @return null|string the jailed path or null if the path is outside the jail
68
+     */
69
+    protected function getJailedPath($path) {
70
+        if ($this->getRoot() === '') {
71
+            return $path;
72
+        }
73
+        $rootLength = strlen($this->getRoot()) + 1;
74
+        if ($path === $this->getRoot()) {
75
+            return '';
76
+        } else if (substr($path, 0, $rootLength) === $this->getRoot() . '/') {
77
+            return substr($path, $rootLength);
78
+        } else {
79
+            return null;
80
+        }
81
+    }
82
+
83
+    /**
84
+     * @param ICacheEntry|array $entry
85
+     * @return array
86
+     */
87
+    protected function formatCacheEntry($entry) {
88
+        if (isset($entry['path'])) {
89
+            $entry['path'] = $this->getJailedPath($entry['path']);
90
+        }
91
+        return $entry;
92
+    }
93
+
94
+    protected function filterCacheEntry($entry) {
95
+        $rootLength = strlen($this->getRoot()) + 1;
96
+        return ($entry['path'] === $this->getRoot()) or (substr($entry['path'], 0, $rootLength) === $this->getRoot() . '/');
97
+    }
98
+
99
+    /**
100
+     * get the stored metadata of a file or folder
101
+     *
102
+     * @param string /int $file
103
+     * @return ICacheEntry|false
104
+     */
105
+    public function get($file) {
106
+        if (is_string($file) or $file == '') {
107
+            $file = $this->getSourcePath($file);
108
+        }
109
+        return parent::get($file);
110
+    }
111
+
112
+    /**
113
+     * insert meta data for a new file or folder
114
+     *
115
+     * @param string $file
116
+     * @param array $data
117
+     *
118
+     * @return int file id
119
+     * @throws \RuntimeException
120
+     */
121
+    public function insert($file, array $data) {
122
+        return $this->getCache()->insert($this->getSourcePath($file), $data);
123
+    }
124
+
125
+    /**
126
+     * update the metadata in the cache
127
+     *
128
+     * @param int $id
129
+     * @param array $data
130
+     */
131
+    public function update($id, array $data) {
132
+        $this->getCache()->update($id, $data);
133
+    }
134
+
135
+    /**
136
+     * get the file id for a file
137
+     *
138
+     * @param string $file
139
+     * @return int
140
+     */
141
+    public function getId($file) {
142
+        return $this->getCache()->getId($this->getSourcePath($file));
143
+    }
144
+
145
+    /**
146
+     * get the id of the parent folder of a file
147
+     *
148
+     * @param string $file
149
+     * @return int
150
+     */
151
+    public function getParentId($file) {
152
+        return $this->getCache()->getParentId($this->getSourcePath($file));
153
+    }
154
+
155
+    /**
156
+     * check if a file is available in the cache
157
+     *
158
+     * @param string $file
159
+     * @return bool
160
+     */
161
+    public function inCache($file) {
162
+        return $this->getCache()->inCache($this->getSourcePath($file));
163
+    }
164
+
165
+    /**
166
+     * remove a file or folder from the cache
167
+     *
168
+     * @param string $file
169
+     */
170
+    public function remove($file) {
171
+        $this->getCache()->remove($this->getSourcePath($file));
172
+    }
173
+
174
+    /**
175
+     * Move a file or folder in the cache
176
+     *
177
+     * @param string $source
178
+     * @param string $target
179
+     */
180
+    public function move($source, $target) {
181
+        $this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target));
182
+    }
183
+
184
+    /**
185
+     * Get the storage id and path needed for a move
186
+     *
187
+     * @param string $path
188
+     * @return array [$storageId, $internalPath]
189
+     */
190
+    protected function getMoveInfo($path) {
191
+        return [$this->getNumericStorageId(), $this->getSourcePath($path)];
192
+    }
193
+
194
+    /**
195
+     * remove all entries for files that are stored on the storage from the cache
196
+     */
197
+    public function clear() {
198
+        $this->getCache()->remove($this->getRoot());
199
+    }
200
+
201
+    /**
202
+     * @param string $file
203
+     *
204
+     * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE
205
+     */
206
+    public function getStatus($file) {
207
+        return $this->getCache()->getStatus($this->getSourcePath($file));
208
+    }
209
+
210
+    private function formatSearchResults($results) {
211
+        $results = array_filter($results, array($this, 'filterCacheEntry'));
212
+        $results = array_values($results);
213
+        return array_map(array($this, 'formatCacheEntry'), $results);
214
+    }
215
+
216
+    /**
217
+     * search for files matching $pattern
218
+     *
219
+     * @param string $pattern
220
+     * @return array an array of file data
221
+     */
222
+    public function search($pattern) {
223
+        $results = $this->getCache()->search($pattern);
224
+        return $this->formatSearchResults($results);
225
+    }
226
+
227
+    /**
228
+     * search for files by mimetype
229
+     *
230
+     * @param string $mimetype
231
+     * @return array
232
+     */
233
+    public function searchByMime($mimetype) {
234
+        $results = $this->getCache()->searchByMime($mimetype);
235
+        return $this->formatSearchResults($results);
236
+    }
237
+
238
+    public function searchQuery(ISearchQuery $query) {
239
+        $results = $this->getCache()->searchQuery($query);
240
+        return $this->formatSearchResults($results);
241
+    }
242
+
243
+    /**
244
+     * search for files by mimetype
245
+     *
246
+     * @param string|int $tag name or tag id
247
+     * @param string $userId owner of the tags
248
+     * @return array
249
+     */
250
+    public function searchByTag($tag, $userId) {
251
+        $results = $this->getCache()->searchByTag($tag, $userId);
252
+        return $this->formatSearchResults($results);
253
+    }
254
+
255
+    /**
256
+     * update the folder size and the size of all parent folders
257
+     *
258
+     * @param string|boolean $path
259
+     * @param array $data (optional) meta data of the folder
260
+     */
261
+    public function correctFolderSize($path, $data = null) {
262
+        if ($this->getCache() instanceof Cache) {
263
+            $this->getCache()->correctFolderSize($this->getSourcePath($path), $data);
264
+        }
265
+    }
266
+
267
+    /**
268
+     * get the size of a folder and set it in the cache
269
+     *
270
+     * @param string $path
271
+     * @param array $entry (optional) meta data of the folder
272
+     * @return int
273
+     */
274
+    public function calculateFolderSize($path, $entry = null) {
275
+        if ($this->getCache() instanceof Cache) {
276
+            return $this->getCache()->calculateFolderSize($this->getSourcePath($path), $entry);
277
+        } else {
278
+            return 0;
279
+        }
280
+
281
+    }
282
+
283
+    /**
284
+     * get all file ids on the files on the storage
285
+     *
286
+     * @return int[]
287
+     */
288
+    public function getAll() {
289
+        // not supported
290
+        return array();
291
+    }
292
+
293
+    /**
294
+     * find a folder in the cache which has not been fully scanned
295
+     *
296
+     * If multiply incomplete folders are in the cache, the one with the highest id will be returned,
297
+     * use the one with the highest id gives the best result with the background scanner, since that is most
298
+     * likely the folder where we stopped scanning previously
299
+     *
300
+     * @return string|bool the path of the folder or false when no folder matched
301
+     */
302
+    public function getIncomplete() {
303
+        // not supported
304
+        return false;
305
+    }
306
+
307
+    /**
308
+     * get the path of a file on this storage by it's id
309
+     *
310
+     * @param int $id
311
+     * @return string|null
312
+     */
313
+    public function getPathById($id) {
314
+        $path = $this->getCache()->getPathById($id);
315
+        return $this->getJailedPath($path);
316
+    }
317
+
318
+    /**
319
+     * Move a file or folder in the cache
320
+     *
321
+     * Note that this should make sure the entries are removed from the source cache
322
+     *
323
+     * @param \OCP\Files\Cache\ICache $sourceCache
324
+     * @param string $sourcePath
325
+     * @param string $targetPath
326
+     */
327
+    public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) {
328
+        if ($sourceCache === $this) {
329
+            return $this->move($sourcePath, $targetPath);
330
+        }
331
+        return $this->getCache()->moveFromCache($sourceCache, $sourcePath, $this->getSourcePath($targetPath));
332
+    }
333 333
 }
Please login to merge, or discard this patch.
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -58,7 +58,7 @@  discard block
 block discarded – undo
58 58
 		if ($path === '') {
59 59
 			return $this->getRoot();
60 60
 		} else {
61
-			return $this->getRoot() . '/' . ltrim($path, '/');
61
+			return $this->getRoot().'/'.ltrim($path, '/');
62 62
 		}
63 63
 	}
64 64
 
@@ -73,7 +73,7 @@  discard block
 block discarded – undo
73 73
 		$rootLength = strlen($this->getRoot()) + 1;
74 74
 		if ($path === $this->getRoot()) {
75 75
 			return '';
76
-		} else if (substr($path, 0, $rootLength) === $this->getRoot() . '/') {
76
+		} else if (substr($path, 0, $rootLength) === $this->getRoot().'/') {
77 77
 			return substr($path, $rootLength);
78 78
 		} else {
79 79
 			return null;
@@ -93,7 +93,7 @@  discard block
 block discarded – undo
93 93
 
94 94
 	protected function filterCacheEntry($entry) {
95 95
 		$rootLength = strlen($this->getRoot()) + 1;
96
-		return ($entry['path'] === $this->getRoot()) or (substr($entry['path'], 0, $rootLength) === $this->getRoot() . '/');
96
+		return ($entry['path'] === $this->getRoot()) or (substr($entry['path'], 0, $rootLength) === $this->getRoot().'/');
97 97
 	}
98 98
 
99 99
 	/**
Please login to merge, or discard this patch.
lib/private/Group/Manager.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -156,7 +156,7 @@
 block discarded – undo
156 156
 	/**
157 157
 	 * @param string $gid
158 158
 	 * @param string $displayName
159
-	 * @return \OCP\IGroup
159
+	 * @return null|Group
160 160
 	 */
161 161
 	protected function getGroupObject($gid, $displayName = null) {
162 162
 		$backends = array();
Please login to merge, or discard this patch.
Spacing   +15 added lines, -15 removed lines patch added patch discarded remove patch
@@ -93,20 +93,20 @@  discard block
 block discarded – undo
93 93
 		$this->logger = $logger;
94 94
 		$cachedGroups = & $this->cachedGroups;
95 95
 		$cachedUserGroups = & $this->cachedUserGroups;
96
-		$this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
96
+		$this->listen('\OC\Group', 'postDelete', function($group) use (&$cachedGroups, &$cachedUserGroups) {
97 97
 			/**
98 98
 			 * @var \OC\Group\Group $group
99 99
 			 */
100 100
 			unset($cachedGroups[$group->getGID()]);
101 101
 			$cachedUserGroups = array();
102 102
 		});
103
-		$this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
103
+		$this->listen('\OC\Group', 'postAddUser', function($group) use (&$cachedUserGroups) {
104 104
 			/**
105 105
 			 * @var \OC\Group\Group $group
106 106
 			 */
107 107
 			$cachedUserGroups = array();
108 108
 		});
109
-		$this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
109
+		$this->listen('\OC\Group', 'postRemoveUser', function($group) use (&$cachedUserGroups) {
110 110
 			/**
111 111
 			 * @var \OC\Group\Group $group
112 112
 			 */
@@ -235,7 +235,7 @@  discard block
 block discarded – undo
235 235
 				if ($aGroup instanceof IGroup) {
236 236
 					$groups[$groupId] = $aGroup;
237 237
 				} else {
238
-					$this->logger->debug('Group "' . $groupId . '" was returned by search but not found through direct access', ['app' => 'core']);
238
+					$this->logger->debug('Group "'.$groupId.'" was returned by search but not found through direct access', ['app' => 'core']);
239 239
 				}
240 240
 			}
241 241
 			if (!is_null($limit) and $limit <= 0) {
@@ -249,7 +249,7 @@  discard block
 block discarded – undo
249 249
 	 * @param IUser|null $user
250 250
 	 * @return \OC\Group\Group[]
251 251
 	 */
252
-	public function getUserGroups(IUser $user= null) {
252
+	public function getUserGroups(IUser $user = null) {
253 253
 		if (!$user instanceof IUser) {
254 254
 			return [];
255 255
 		}
@@ -273,7 +273,7 @@  discard block
 block discarded – undo
273 273
 					if ($aGroup instanceof IGroup) {
274 274
 						$groups[$groupId] = $aGroup;
275 275
 					} else {
276
-						$this->logger->debug('User "' . $uid . '" belongs to deleted group: "' . $groupId . '"', ['app' => 'core']);
276
+						$this->logger->debug('User "'.$uid.'" belongs to deleted group: "'.$groupId.'"', ['app' => 'core']);
277 277
 					}
278 278
 				}
279 279
 			}
@@ -322,32 +322,32 @@  discard block
 block discarded – undo
322 322
 	 */
323 323
 	public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
324 324
 		$group = $this->get($gid);
325
-		if(is_null($group)) {
325
+		if (is_null($group)) {
326 326
 			return array();
327 327
 		}
328 328
 
329 329
 		$search = trim($search);
330 330
 		$groupUsers = array();
331 331
 
332
-		if(!empty($search)) {
332
+		if (!empty($search)) {
333 333
 			// only user backends have the capability to do a complex search for users
334 334
 			$searchOffset = 0;
335 335
 			$searchLimit = $limit * 100;
336
-			if($limit === -1) {
336
+			if ($limit === -1) {
337 337
 				$searchLimit = 500;
338 338
 			}
339 339
 
340 340
 			do {
341 341
 				$filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset);
342
-				foreach($filteredUsers as $filteredUser) {
343
-					if($group->inGroup($filteredUser)) {
344
-						$groupUsers[]= $filteredUser;
342
+				foreach ($filteredUsers as $filteredUser) {
343
+					if ($group->inGroup($filteredUser)) {
344
+						$groupUsers[] = $filteredUser;
345 345
 					}
346 346
 				}
347 347
 				$searchOffset += $searchLimit;
348
-			} while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit);
348
+			} while (count($groupUsers) < $searchLimit + $offset && count($filteredUsers) >= $searchLimit);
349 349
 
350
-			if($limit === -1) {
350
+			if ($limit === -1) {
351 351
 				$groupUsers = array_slice($groupUsers, $offset);
352 352
 			} else {
353 353
 				$groupUsers = array_slice($groupUsers, $offset, $limit);
@@ -357,7 +357,7 @@  discard block
 block discarded – undo
357 357
 		}
358 358
 
359 359
 		$matchingUsers = array();
360
-		foreach($groupUsers as $groupUser) {
360
+		foreach ($groupUsers as $groupUser) {
361 361
 			$matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName();
362 362
 		}
363 363
 		return $matchingUsers;
Please login to merge, or discard this patch.
Indentation   +333 added lines, -333 removed lines patch added patch discarded remove patch
@@ -58,337 +58,337 @@
 block discarded – undo
58 58
  * @package OC\Group
59 59
  */
60 60
 class Manager extends PublicEmitter implements IGroupManager {
61
-	/**
62
-	 * @var GroupInterface[] $backends
63
-	 */
64
-	private $backends = array();
65
-
66
-	/**
67
-	 * @var \OC\User\Manager $userManager
68
-	 */
69
-	private $userManager;
70
-
71
-	/**
72
-	 * @var \OC\Group\Group[]
73
-	 */
74
-	private $cachedGroups = array();
75
-
76
-	/**
77
-	 * @var \OC\Group\Group[]
78
-	 */
79
-	private $cachedUserGroups = array();
80
-
81
-	/** @var \OC\SubAdmin */
82
-	private $subAdmin = null;
83
-
84
-	/** @var ILogger */
85
-	private $logger;
86
-
87
-	/**
88
-	 * @param \OC\User\Manager $userManager
89
-	 * @param ILogger $logger
90
-	 */
91
-	public function __construct(\OC\User\Manager $userManager, ILogger $logger) {
92
-		$this->userManager = $userManager;
93
-		$this->logger = $logger;
94
-		$cachedGroups = & $this->cachedGroups;
95
-		$cachedUserGroups = & $this->cachedUserGroups;
96
-		$this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
97
-			/**
98
-			 * @var \OC\Group\Group $group
99
-			 */
100
-			unset($cachedGroups[$group->getGID()]);
101
-			$cachedUserGroups = array();
102
-		});
103
-		$this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
104
-			/**
105
-			 * @var \OC\Group\Group $group
106
-			 */
107
-			$cachedUserGroups = array();
108
-		});
109
-		$this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
110
-			/**
111
-			 * @var \OC\Group\Group $group
112
-			 */
113
-			$cachedUserGroups = array();
114
-		});
115
-	}
116
-
117
-	/**
118
-	 * Checks whether a given backend is used
119
-	 *
120
-	 * @param string $backendClass Full classname including complete namespace
121
-	 * @return bool
122
-	 */
123
-	public function isBackendUsed($backendClass) {
124
-		$backendClass = strtolower(ltrim($backendClass, '\\'));
125
-
126
-		foreach ($this->backends as $backend) {
127
-			if (strtolower(get_class($backend)) === $backendClass) {
128
-				return true;
129
-			}
130
-		}
131
-
132
-		return false;
133
-	}
134
-
135
-	/**
136
-	 * @param \OCP\GroupInterface $backend
137
-	 */
138
-	public function addBackend($backend) {
139
-		$this->backends[] = $backend;
140
-		$this->clearCaches();
141
-	}
142
-
143
-	public function clearBackends() {
144
-		$this->backends = array();
145
-		$this->clearCaches();
146
-	}
147
-
148
-	/**
149
-	 * Get the active backends
150
-	 * @return \OCP\GroupInterface[]
151
-	 */
152
-	public function getBackends() {
153
-		return $this->backends;
154
-	}
155
-
156
-
157
-	protected function clearCaches() {
158
-		$this->cachedGroups = array();
159
-		$this->cachedUserGroups = array();
160
-	}
161
-
162
-	/**
163
-	 * @param string $gid
164
-	 * @return \OC\Group\Group
165
-	 */
166
-	public function get($gid) {
167
-		if (isset($this->cachedGroups[$gid])) {
168
-			return $this->cachedGroups[$gid];
169
-		}
170
-		return $this->getGroupObject($gid);
171
-	}
172
-
173
-	/**
174
-	 * @param string $gid
175
-	 * @param string $displayName
176
-	 * @return \OCP\IGroup
177
-	 */
178
-	protected function getGroupObject($gid, $displayName = null) {
179
-		$backends = array();
180
-		foreach ($this->backends as $backend) {
181
-			if ($backend->implementsActions(\OC\Group\Backend::GROUP_DETAILS)) {
182
-				$groupData = $backend->getGroupDetails($gid);
183
-				if (is_array($groupData)) {
184
-					// take the display name from the first backend that has a non-null one
185
-					if (is_null($displayName) && isset($groupData['displayName'])) {
186
-						$displayName = $groupData['displayName'];
187
-					}
188
-					$backends[] = $backend;
189
-				}
190
-			} else if ($backend->groupExists($gid)) {
191
-				$backends[] = $backend;
192
-			}
193
-		}
194
-		if (count($backends) === 0) {
195
-			return null;
196
-		}
197
-		$this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this, $displayName);
198
-		return $this->cachedGroups[$gid];
199
-	}
200
-
201
-	/**
202
-	 * @param string $gid
203
-	 * @return bool
204
-	 */
205
-	public function groupExists($gid) {
206
-		return $this->get($gid) instanceof IGroup;
207
-	}
208
-
209
-	/**
210
-	 * @param string $gid
211
-	 * @return \OC\Group\Group
212
-	 */
213
-	public function createGroup($gid) {
214
-		if ($gid === '' || $gid === null) {
215
-			return false;
216
-		} else if ($group = $this->get($gid)) {
217
-			return $group;
218
-		} else {
219
-			$this->emit('\OC\Group', 'preCreate', array($gid));
220
-			foreach ($this->backends as $backend) {
221
-				if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) {
222
-					$backend->createGroup($gid);
223
-					$group = $this->getGroupObject($gid);
224
-					$this->emit('\OC\Group', 'postCreate', array($group));
225
-					return $group;
226
-				}
227
-			}
228
-			return null;
229
-		}
230
-	}
231
-
232
-	/**
233
-	 * @param string $search
234
-	 * @param int $limit
235
-	 * @param int $offset
236
-	 * @return \OC\Group\Group[]
237
-	 */
238
-	public function search($search, $limit = null, $offset = null) {
239
-		$groups = array();
240
-		foreach ($this->backends as $backend) {
241
-			$groupIds = $backend->getGroups($search, $limit, $offset);
242
-			foreach ($groupIds as $groupId) {
243
-				$aGroup = $this->get($groupId);
244
-				if ($aGroup instanceof IGroup) {
245
-					$groups[$groupId] = $aGroup;
246
-				} else {
247
-					$this->logger->debug('Group "' . $groupId . '" was returned by search but not found through direct access', ['app' => 'core']);
248
-				}
249
-			}
250
-			if (!is_null($limit) and $limit <= 0) {
251
-				return array_values($groups);
252
-			}
253
-		}
254
-		return array_values($groups);
255
-	}
256
-
257
-	/**
258
-	 * @param IUser|null $user
259
-	 * @return \OC\Group\Group[]
260
-	 */
261
-	public function getUserGroups(IUser $user= null) {
262
-		if (!$user instanceof IUser) {
263
-			return [];
264
-		}
265
-		return $this->getUserIdGroups($user->getUID());
266
-	}
267
-
268
-	/**
269
-	 * @param string $uid the user id
270
-	 * @return \OC\Group\Group[]
271
-	 */
272
-	public function getUserIdGroups($uid) {
273
-		if (isset($this->cachedUserGroups[$uid])) {
274
-			return $this->cachedUserGroups[$uid];
275
-		}
276
-		$groups = array();
277
-		foreach ($this->backends as $backend) {
278
-			$groupIds = $backend->getUserGroups($uid);
279
-			if (is_array($groupIds)) {
280
-				foreach ($groupIds as $groupId) {
281
-					$aGroup = $this->get($groupId);
282
-					if ($aGroup instanceof IGroup) {
283
-						$groups[$groupId] = $aGroup;
284
-					} else {
285
-						$this->logger->debug('User "' . $uid . '" belongs to deleted group: "' . $groupId . '"', ['app' => 'core']);
286
-					}
287
-				}
288
-			}
289
-		}
290
-		$this->cachedUserGroups[$uid] = $groups;
291
-		return $this->cachedUserGroups[$uid];
292
-	}
293
-
294
-	/**
295
-	 * Checks if a userId is in the admin group
296
-	 * @param string $userId
297
-	 * @return bool if admin
298
-	 */
299
-	public function isAdmin($userId) {
300
-		foreach ($this->backends as $backend) {
301
-			if ($backend->implementsActions(\OC\Group\Backend::IS_ADMIN) && $backend->isAdmin($userId)) {
302
-				return true;
303
-			}
304
-		}
305
-		return $this->isInGroup($userId, 'admin');
306
-	}
307
-
308
-	/**
309
-	 * Checks if a userId is in a group
310
-	 * @param string $userId
311
-	 * @param string $group
312
-	 * @return bool if in group
313
-	 */
314
-	public function isInGroup($userId, $group) {
315
-		return array_key_exists($group, $this->getUserIdGroups($userId));
316
-	}
317
-
318
-	/**
319
-	 * get a list of group ids for a user
320
-	 * @param IUser $user
321
-	 * @return array with group ids
322
-	 */
323
-	public function getUserGroupIds(IUser $user) {
324
-		return array_map(function($value) {
325
-			return (string) $value;
326
-		}, array_keys($this->getUserGroups($user)));
327
-	}
328
-
329
-	/**
330
-	 * get a list of all display names in a group
331
-	 * @param string $gid
332
-	 * @param string $search
333
-	 * @param int $limit
334
-	 * @param int $offset
335
-	 * @return array an array of display names (value) and user ids (key)
336
-	 */
337
-	public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
338
-		$group = $this->get($gid);
339
-		if(is_null($group)) {
340
-			return array();
341
-		}
342
-
343
-		$search = trim($search);
344
-		$groupUsers = array();
345
-
346
-		if(!empty($search)) {
347
-			// only user backends have the capability to do a complex search for users
348
-			$searchOffset = 0;
349
-			$searchLimit = $limit * 100;
350
-			if($limit === -1) {
351
-				$searchLimit = 500;
352
-			}
353
-
354
-			do {
355
-				$filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset);
356
-				foreach($filteredUsers as $filteredUser) {
357
-					if($group->inGroup($filteredUser)) {
358
-						$groupUsers[]= $filteredUser;
359
-					}
360
-				}
361
-				$searchOffset += $searchLimit;
362
-			} while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit);
363
-
364
-			if($limit === -1) {
365
-				$groupUsers = array_slice($groupUsers, $offset);
366
-			} else {
367
-				$groupUsers = array_slice($groupUsers, $offset, $limit);
368
-			}
369
-		} else {
370
-			$groupUsers = $group->searchUsers('', $limit, $offset);
371
-		}
372
-
373
-		$matchingUsers = array();
374
-		foreach($groupUsers as $groupUser) {
375
-			$matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName();
376
-		}
377
-		return $matchingUsers;
378
-	}
379
-
380
-	/**
381
-	 * @return \OC\SubAdmin
382
-	 */
383
-	public function getSubAdmin() {
384
-		if (!$this->subAdmin) {
385
-			$this->subAdmin = new \OC\SubAdmin(
386
-				$this->userManager,
387
-				$this,
388
-				\OC::$server->getDatabaseConnection()
389
-			);
390
-		}
391
-
392
-		return $this->subAdmin;
393
-	}
61
+    /**
62
+     * @var GroupInterface[] $backends
63
+     */
64
+    private $backends = array();
65
+
66
+    /**
67
+     * @var \OC\User\Manager $userManager
68
+     */
69
+    private $userManager;
70
+
71
+    /**
72
+     * @var \OC\Group\Group[]
73
+     */
74
+    private $cachedGroups = array();
75
+
76
+    /**
77
+     * @var \OC\Group\Group[]
78
+     */
79
+    private $cachedUserGroups = array();
80
+
81
+    /** @var \OC\SubAdmin */
82
+    private $subAdmin = null;
83
+
84
+    /** @var ILogger */
85
+    private $logger;
86
+
87
+    /**
88
+     * @param \OC\User\Manager $userManager
89
+     * @param ILogger $logger
90
+     */
91
+    public function __construct(\OC\User\Manager $userManager, ILogger $logger) {
92
+        $this->userManager = $userManager;
93
+        $this->logger = $logger;
94
+        $cachedGroups = & $this->cachedGroups;
95
+        $cachedUserGroups = & $this->cachedUserGroups;
96
+        $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
97
+            /**
98
+             * @var \OC\Group\Group $group
99
+             */
100
+            unset($cachedGroups[$group->getGID()]);
101
+            $cachedUserGroups = array();
102
+        });
103
+        $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
104
+            /**
105
+             * @var \OC\Group\Group $group
106
+             */
107
+            $cachedUserGroups = array();
108
+        });
109
+        $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
110
+            /**
111
+             * @var \OC\Group\Group $group
112
+             */
113
+            $cachedUserGroups = array();
114
+        });
115
+    }
116
+
117
+    /**
118
+     * Checks whether a given backend is used
119
+     *
120
+     * @param string $backendClass Full classname including complete namespace
121
+     * @return bool
122
+     */
123
+    public function isBackendUsed($backendClass) {
124
+        $backendClass = strtolower(ltrim($backendClass, '\\'));
125
+
126
+        foreach ($this->backends as $backend) {
127
+            if (strtolower(get_class($backend)) === $backendClass) {
128
+                return true;
129
+            }
130
+        }
131
+
132
+        return false;
133
+    }
134
+
135
+    /**
136
+     * @param \OCP\GroupInterface $backend
137
+     */
138
+    public function addBackend($backend) {
139
+        $this->backends[] = $backend;
140
+        $this->clearCaches();
141
+    }
142
+
143
+    public function clearBackends() {
144
+        $this->backends = array();
145
+        $this->clearCaches();
146
+    }
147
+
148
+    /**
149
+     * Get the active backends
150
+     * @return \OCP\GroupInterface[]
151
+     */
152
+    public function getBackends() {
153
+        return $this->backends;
154
+    }
155
+
156
+
157
+    protected function clearCaches() {
158
+        $this->cachedGroups = array();
159
+        $this->cachedUserGroups = array();
160
+    }
161
+
162
+    /**
163
+     * @param string $gid
164
+     * @return \OC\Group\Group
165
+     */
166
+    public function get($gid) {
167
+        if (isset($this->cachedGroups[$gid])) {
168
+            return $this->cachedGroups[$gid];
169
+        }
170
+        return $this->getGroupObject($gid);
171
+    }
172
+
173
+    /**
174
+     * @param string $gid
175
+     * @param string $displayName
176
+     * @return \OCP\IGroup
177
+     */
178
+    protected function getGroupObject($gid, $displayName = null) {
179
+        $backends = array();
180
+        foreach ($this->backends as $backend) {
181
+            if ($backend->implementsActions(\OC\Group\Backend::GROUP_DETAILS)) {
182
+                $groupData = $backend->getGroupDetails($gid);
183
+                if (is_array($groupData)) {
184
+                    // take the display name from the first backend that has a non-null one
185
+                    if (is_null($displayName) && isset($groupData['displayName'])) {
186
+                        $displayName = $groupData['displayName'];
187
+                    }
188
+                    $backends[] = $backend;
189
+                }
190
+            } else if ($backend->groupExists($gid)) {
191
+                $backends[] = $backend;
192
+            }
193
+        }
194
+        if (count($backends) === 0) {
195
+            return null;
196
+        }
197
+        $this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this, $displayName);
198
+        return $this->cachedGroups[$gid];
199
+    }
200
+
201
+    /**
202
+     * @param string $gid
203
+     * @return bool
204
+     */
205
+    public function groupExists($gid) {
206
+        return $this->get($gid) instanceof IGroup;
207
+    }
208
+
209
+    /**
210
+     * @param string $gid
211
+     * @return \OC\Group\Group
212
+     */
213
+    public function createGroup($gid) {
214
+        if ($gid === '' || $gid === null) {
215
+            return false;
216
+        } else if ($group = $this->get($gid)) {
217
+            return $group;
218
+        } else {
219
+            $this->emit('\OC\Group', 'preCreate', array($gid));
220
+            foreach ($this->backends as $backend) {
221
+                if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) {
222
+                    $backend->createGroup($gid);
223
+                    $group = $this->getGroupObject($gid);
224
+                    $this->emit('\OC\Group', 'postCreate', array($group));
225
+                    return $group;
226
+                }
227
+            }
228
+            return null;
229
+        }
230
+    }
231
+
232
+    /**
233
+     * @param string $search
234
+     * @param int $limit
235
+     * @param int $offset
236
+     * @return \OC\Group\Group[]
237
+     */
238
+    public function search($search, $limit = null, $offset = null) {
239
+        $groups = array();
240
+        foreach ($this->backends as $backend) {
241
+            $groupIds = $backend->getGroups($search, $limit, $offset);
242
+            foreach ($groupIds as $groupId) {
243
+                $aGroup = $this->get($groupId);
244
+                if ($aGroup instanceof IGroup) {
245
+                    $groups[$groupId] = $aGroup;
246
+                } else {
247
+                    $this->logger->debug('Group "' . $groupId . '" was returned by search but not found through direct access', ['app' => 'core']);
248
+                }
249
+            }
250
+            if (!is_null($limit) and $limit <= 0) {
251
+                return array_values($groups);
252
+            }
253
+        }
254
+        return array_values($groups);
255
+    }
256
+
257
+    /**
258
+     * @param IUser|null $user
259
+     * @return \OC\Group\Group[]
260
+     */
261
+    public function getUserGroups(IUser $user= null) {
262
+        if (!$user instanceof IUser) {
263
+            return [];
264
+        }
265
+        return $this->getUserIdGroups($user->getUID());
266
+    }
267
+
268
+    /**
269
+     * @param string $uid the user id
270
+     * @return \OC\Group\Group[]
271
+     */
272
+    public function getUserIdGroups($uid) {
273
+        if (isset($this->cachedUserGroups[$uid])) {
274
+            return $this->cachedUserGroups[$uid];
275
+        }
276
+        $groups = array();
277
+        foreach ($this->backends as $backend) {
278
+            $groupIds = $backend->getUserGroups($uid);
279
+            if (is_array($groupIds)) {
280
+                foreach ($groupIds as $groupId) {
281
+                    $aGroup = $this->get($groupId);
282
+                    if ($aGroup instanceof IGroup) {
283
+                        $groups[$groupId] = $aGroup;
284
+                    } else {
285
+                        $this->logger->debug('User "' . $uid . '" belongs to deleted group: "' . $groupId . '"', ['app' => 'core']);
286
+                    }
287
+                }
288
+            }
289
+        }
290
+        $this->cachedUserGroups[$uid] = $groups;
291
+        return $this->cachedUserGroups[$uid];
292
+    }
293
+
294
+    /**
295
+     * Checks if a userId is in the admin group
296
+     * @param string $userId
297
+     * @return bool if admin
298
+     */
299
+    public function isAdmin($userId) {
300
+        foreach ($this->backends as $backend) {
301
+            if ($backend->implementsActions(\OC\Group\Backend::IS_ADMIN) && $backend->isAdmin($userId)) {
302
+                return true;
303
+            }
304
+        }
305
+        return $this->isInGroup($userId, 'admin');
306
+    }
307
+
308
+    /**
309
+     * Checks if a userId is in a group
310
+     * @param string $userId
311
+     * @param string $group
312
+     * @return bool if in group
313
+     */
314
+    public function isInGroup($userId, $group) {
315
+        return array_key_exists($group, $this->getUserIdGroups($userId));
316
+    }
317
+
318
+    /**
319
+     * get a list of group ids for a user
320
+     * @param IUser $user
321
+     * @return array with group ids
322
+     */
323
+    public function getUserGroupIds(IUser $user) {
324
+        return array_map(function($value) {
325
+            return (string) $value;
326
+        }, array_keys($this->getUserGroups($user)));
327
+    }
328
+
329
+    /**
330
+     * get a list of all display names in a group
331
+     * @param string $gid
332
+     * @param string $search
333
+     * @param int $limit
334
+     * @param int $offset
335
+     * @return array an array of display names (value) and user ids (key)
336
+     */
337
+    public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
338
+        $group = $this->get($gid);
339
+        if(is_null($group)) {
340
+            return array();
341
+        }
342
+
343
+        $search = trim($search);
344
+        $groupUsers = array();
345
+
346
+        if(!empty($search)) {
347
+            // only user backends have the capability to do a complex search for users
348
+            $searchOffset = 0;
349
+            $searchLimit = $limit * 100;
350
+            if($limit === -1) {
351
+                $searchLimit = 500;
352
+            }
353
+
354
+            do {
355
+                $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset);
356
+                foreach($filteredUsers as $filteredUser) {
357
+                    if($group->inGroup($filteredUser)) {
358
+                        $groupUsers[]= $filteredUser;
359
+                    }
360
+                }
361
+                $searchOffset += $searchLimit;
362
+            } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit);
363
+
364
+            if($limit === -1) {
365
+                $groupUsers = array_slice($groupUsers, $offset);
366
+            } else {
367
+                $groupUsers = array_slice($groupUsers, $offset, $limit);
368
+            }
369
+        } else {
370
+            $groupUsers = $group->searchUsers('', $limit, $offset);
371
+        }
372
+
373
+        $matchingUsers = array();
374
+        foreach($groupUsers as $groupUser) {
375
+            $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName();
376
+        }
377
+        return $matchingUsers;
378
+    }
379
+
380
+    /**
381
+     * @return \OC\SubAdmin
382
+     */
383
+    public function getSubAdmin() {
384
+        if (!$this->subAdmin) {
385
+            $this->subAdmin = new \OC\SubAdmin(
386
+                $this->userManager,
387
+                $this,
388
+                \OC::$server->getDatabaseConnection()
389
+            );
390
+        }
391
+
392
+        return $this->subAdmin;
393
+    }
394 394
 }
Please login to merge, or discard this patch.
lib/private/Memcache/APCu.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -65,7 +65,7 @@
 block discarded – undo
65 65
 	 * Set a value in the cache if it's not already stored
66 66
 	 *
67 67
 	 * @param string $key
68
-	 * @param mixed $value
68
+	 * @param integer $value
69 69
 	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
70 70
 	 * @return bool
71 71
 	 */
Please login to merge, or discard this patch.
Spacing   +14 added lines, -14 removed lines patch added patch discarded remove patch
@@ -37,7 +37,7 @@  discard block
 block discarded – undo
37 37
 	use CADTrait;
38 38
 
39 39
 	public function get($key) {
40
-		$result = apcu_fetch($this->getPrefix() . $key, $success);
40
+		$result = apcu_fetch($this->getPrefix().$key, $success);
41 41
 		if (!$success) {
42 42
 			return null;
43 43
 		}
@@ -45,24 +45,24 @@  discard block
 block discarded – undo
45 45
 	}
46 46
 
47 47
 	public function set($key, $value, $ttl = 0) {
48
-		return apcu_store($this->getPrefix() . $key, $value, $ttl);
48
+		return apcu_store($this->getPrefix().$key, $value, $ttl);
49 49
 	}
50 50
 
51 51
 	public function hasKey($key) {
52
-		return apcu_exists($this->getPrefix() . $key);
52
+		return apcu_exists($this->getPrefix().$key);
53 53
 	}
54 54
 
55 55
 	public function remove($key) {
56
-		return apcu_delete($this->getPrefix() . $key);
56
+		return apcu_delete($this->getPrefix().$key);
57 57
 	}
58 58
 
59 59
 	public function clear($prefix = '') {
60
-		$ns = $this->getPrefix() . $prefix;
60
+		$ns = $this->getPrefix().$prefix;
61 61
 		$ns = preg_quote($ns, '/');
62
-		if(class_exists('\APCIterator')) {
63
-			$iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY);
62
+		if (class_exists('\APCIterator')) {
63
+			$iter = new \APCIterator('user', '/^'.$ns.'/', APC_ITER_KEY);
64 64
 		} else {
65
-			$iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY);
65
+			$iter = new \APCUIterator('/^'.$ns.'/', APC_ITER_KEY);
66 66
 		}
67 67
 		return apcu_delete($iter);
68 68
 	}
@@ -76,7 +76,7 @@  discard block
 block discarded – undo
76 76
 	 * @return bool
77 77
 	 */
78 78
 	public function add($key, $value, $ttl = 0) {
79
-		return apcu_add($this->getPrefix() . $key, $value, $ttl);
79
+		return apcu_add($this->getPrefix().$key, $value, $ttl);
80 80
 	}
81 81
 
82 82
 	/**
@@ -100,8 +100,8 @@  discard block
 block discarded – undo
100 100
 		 * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
101 101
 		 * for details
102 102
 		 */
103
-		return apcu_exists($this->getPrefix() . $key)
104
-			? apcu_inc($this->getPrefix() . $key, $step)
103
+		return apcu_exists($this->getPrefix().$key)
104
+			? apcu_inc($this->getPrefix().$key, $step)
105 105
 			: false;
106 106
 	}
107 107
 
@@ -125,8 +125,8 @@  discard block
 block discarded – undo
125 125
 		 * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
126 126
 		 * for details
127 127
 		 */
128
-		return apcu_exists($this->getPrefix() . $key)
129
-			? apcu_dec($this->getPrefix() . $key, $step)
128
+		return apcu_exists($this->getPrefix().$key)
129
+			? apcu_dec($this->getPrefix().$key, $step)
130 130
 			: false;
131 131
 	}
132 132
 
@@ -141,7 +141,7 @@  discard block
 block discarded – undo
141 141
 	public function cas($key, $old, $new) {
142 142
 		// apc only does cas for ints
143 143
 		if (is_int($old) and is_int($new)) {
144
-			return apcu_cas($this->getPrefix() . $key, $old, $new);
144
+			return apcu_cas($this->getPrefix().$key, $old, $new);
145 145
 		} else {
146 146
 			return $this->casEmulated($key, $old, $new);
147 147
 		}
Please login to merge, or discard this patch.
Indentation   +125 added lines, -125 removed lines patch added patch discarded remove patch
@@ -30,140 +30,140 @@
 block discarded – undo
30 30
 use OCP\IMemcache;
31 31
 
32 32
 class APCu extends Cache implements IMemcache {
33
-	use CASTrait {
34
-		cas as casEmulated;
35
-	}
33
+    use CASTrait {
34
+        cas as casEmulated;
35
+    }
36 36
 
37
-	use CADTrait;
37
+    use CADTrait;
38 38
 
39
-	public function get($key) {
40
-		$result = apcu_fetch($this->getPrefix() . $key, $success);
41
-		if (!$success) {
42
-			return null;
43
-		}
44
-		return $result;
45
-	}
39
+    public function get($key) {
40
+        $result = apcu_fetch($this->getPrefix() . $key, $success);
41
+        if (!$success) {
42
+            return null;
43
+        }
44
+        return $result;
45
+    }
46 46
 
47
-	public function set($key, $value, $ttl = 0) {
48
-		return apcu_store($this->getPrefix() . $key, $value, $ttl);
49
-	}
47
+    public function set($key, $value, $ttl = 0) {
48
+        return apcu_store($this->getPrefix() . $key, $value, $ttl);
49
+    }
50 50
 
51
-	public function hasKey($key) {
52
-		return apcu_exists($this->getPrefix() . $key);
53
-	}
51
+    public function hasKey($key) {
52
+        return apcu_exists($this->getPrefix() . $key);
53
+    }
54 54
 
55
-	public function remove($key) {
56
-		return apcu_delete($this->getPrefix() . $key);
57
-	}
55
+    public function remove($key) {
56
+        return apcu_delete($this->getPrefix() . $key);
57
+    }
58 58
 
59
-	public function clear($prefix = '') {
60
-		$ns = $this->getPrefix() . $prefix;
61
-		$ns = preg_quote($ns, '/');
62
-		if(class_exists('\APCIterator')) {
63
-			$iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY);
64
-		} else {
65
-			$iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY);
66
-		}
67
-		return apcu_delete($iter);
68
-	}
59
+    public function clear($prefix = '') {
60
+        $ns = $this->getPrefix() . $prefix;
61
+        $ns = preg_quote($ns, '/');
62
+        if(class_exists('\APCIterator')) {
63
+            $iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY);
64
+        } else {
65
+            $iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY);
66
+        }
67
+        return apcu_delete($iter);
68
+    }
69 69
 
70
-	/**
71
-	 * Set a value in the cache if it's not already stored
72
-	 *
73
-	 * @param string $key
74
-	 * @param mixed $value
75
-	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
76
-	 * @return bool
77
-	 */
78
-	public function add($key, $value, $ttl = 0) {
79
-		return apcu_add($this->getPrefix() . $key, $value, $ttl);
80
-	}
70
+    /**
71
+     * Set a value in the cache if it's not already stored
72
+     *
73
+     * @param string $key
74
+     * @param mixed $value
75
+     * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
76
+     * @return bool
77
+     */
78
+    public function add($key, $value, $ttl = 0) {
79
+        return apcu_add($this->getPrefix() . $key, $value, $ttl);
80
+    }
81 81
 
82
-	/**
83
-	 * Increase a stored number
84
-	 *
85
-	 * @param string $key
86
-	 * @param int $step
87
-	 * @return int | bool
88
-	 */
89
-	public function inc($key, $step = 1) {
90
-		$this->add($key, 0);
91
-		/**
92
-		 * TODO - hack around a PHP 7 specific issue in APCu
93
-		 *
94
-		 * on PHP 7 the apcu_inc method on a non-existing object will increment
95
-		 * "0" and result in "1" as value - therefore we check for existence
96
-		 * first
97
-		 *
98
-		 * on PHP 5.6 this is not the case
99
-		 *
100
-		 * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
101
-		 * for details
102
-		 */
103
-		return apcu_exists($this->getPrefix() . $key)
104
-			? apcu_inc($this->getPrefix() . $key, $step)
105
-			: false;
106
-	}
82
+    /**
83
+     * Increase a stored number
84
+     *
85
+     * @param string $key
86
+     * @param int $step
87
+     * @return int | bool
88
+     */
89
+    public function inc($key, $step = 1) {
90
+        $this->add($key, 0);
91
+        /**
92
+         * TODO - hack around a PHP 7 specific issue in APCu
93
+         *
94
+         * on PHP 7 the apcu_inc method on a non-existing object will increment
95
+         * "0" and result in "1" as value - therefore we check for existence
96
+         * first
97
+         *
98
+         * on PHP 5.6 this is not the case
99
+         *
100
+         * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
101
+         * for details
102
+         */
103
+        return apcu_exists($this->getPrefix() . $key)
104
+            ? apcu_inc($this->getPrefix() . $key, $step)
105
+            : false;
106
+    }
107 107
 
108
-	/**
109
-	 * Decrease a stored number
110
-	 *
111
-	 * @param string $key
112
-	 * @param int $step
113
-	 * @return int | bool
114
-	 */
115
-	public function dec($key, $step = 1) {
116
-		/**
117
-		 * TODO - hack around a PHP 7 specific issue in APCu
118
-		 *
119
-		 * on PHP 7 the apcu_dec method on a non-existing object will decrement
120
-		 * "0" and result in "-1" as value - therefore we check for existence
121
-		 * first
122
-		 *
123
-		 * on PHP 5.6 this is not the case
124
-		 *
125
-		 * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
126
-		 * for details
127
-		 */
128
-		return apcu_exists($this->getPrefix() . $key)
129
-			? apcu_dec($this->getPrefix() . $key, $step)
130
-			: false;
131
-	}
108
+    /**
109
+     * Decrease a stored number
110
+     *
111
+     * @param string $key
112
+     * @param int $step
113
+     * @return int | bool
114
+     */
115
+    public function dec($key, $step = 1) {
116
+        /**
117
+         * TODO - hack around a PHP 7 specific issue in APCu
118
+         *
119
+         * on PHP 7 the apcu_dec method on a non-existing object will decrement
120
+         * "0" and result in "-1" as value - therefore we check for existence
121
+         * first
122
+         *
123
+         * on PHP 5.6 this is not the case
124
+         *
125
+         * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
126
+         * for details
127
+         */
128
+        return apcu_exists($this->getPrefix() . $key)
129
+            ? apcu_dec($this->getPrefix() . $key, $step)
130
+            : false;
131
+    }
132 132
 
133
-	/**
134
-	 * Compare and set
135
-	 *
136
-	 * @param string $key
137
-	 * @param mixed $old
138
-	 * @param mixed $new
139
-	 * @return bool
140
-	 */
141
-	public function cas($key, $old, $new) {
142
-		// apc only does cas for ints
143
-		if (is_int($old) and is_int($new)) {
144
-			return apcu_cas($this->getPrefix() . $key, $old, $new);
145
-		} else {
146
-			return $this->casEmulated($key, $old, $new);
147
-		}
148
-	}
133
+    /**
134
+     * Compare and set
135
+     *
136
+     * @param string $key
137
+     * @param mixed $old
138
+     * @param mixed $new
139
+     * @return bool
140
+     */
141
+    public function cas($key, $old, $new) {
142
+        // apc only does cas for ints
143
+        if (is_int($old) and is_int($new)) {
144
+            return apcu_cas($this->getPrefix() . $key, $old, $new);
145
+        } else {
146
+            return $this->casEmulated($key, $old, $new);
147
+        }
148
+    }
149 149
 
150
-	/**
151
-	 * @return bool
152
-	 */
153
-	static public function isAvailable() {
154
-		if (!extension_loaded('apcu')) {
155
-			return false;
156
-		} elseif (!\OC::$server->getIniWrapper()->getBool('apc.enabled')) {
157
-			return false;
158
-		} elseif (!\OC::$server->getIniWrapper()->getBool('apc.enable_cli') && \OC::$CLI) {
159
-			return false;
160
-		} elseif (
161
-				version_compare(phpversion('apc') ?: '0.0.0', '4.0.6') === -1 &&
162
-				version_compare(phpversion('apcu') ?: '0.0.0', '5.1.0') === -1
163
-		) {
164
-			return false;
165
-		} else {
166
-			return true;
167
-		}
168
-	}
150
+    /**
151
+     * @return bool
152
+     */
153
+    static public function isAvailable() {
154
+        if (!extension_loaded('apcu')) {
155
+            return false;
156
+        } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enabled')) {
157
+            return false;
158
+        } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enable_cli') && \OC::$CLI) {
159
+            return false;
160
+        } elseif (
161
+                version_compare(phpversion('apc') ?: '0.0.0', '4.0.6') === -1 &&
162
+                version_compare(phpversion('apcu') ?: '0.0.0', '5.1.0') === -1
163
+        ) {
164
+            return false;
165
+        } else {
166
+            return true;
167
+        }
168
+    }
169 169
 }
Please login to merge, or discard this patch.
lib/private/Memcache/ArrayCache.php 2 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -65,7 +65,7 @@
 block discarded – undo
65 65
 	 * Set a value in the cache if it's not already stored
66 66
 	 *
67 67
 	 * @param string $key
68
-	 * @param mixed $value
68
+	 * @param integer $value
69 69
 	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
70 70
 	 * @return bool
71 71
 	 */
Please login to merge, or discard this patch.
Indentation   +117 added lines, -117 removed lines patch added patch discarded remove patch
@@ -27,133 +27,133 @@
 block discarded – undo
27 27
 use OCP\IMemcache;
28 28
 
29 29
 class ArrayCache extends Cache implements IMemcache {
30
-	/** @var array Array with the cached data */
31
-	protected $cachedData = array();
30
+    /** @var array Array with the cached data */
31
+    protected $cachedData = array();
32 32
 
33
-	use CADTrait;
33
+    use CADTrait;
34 34
 
35
-	/**
36
-	 * {@inheritDoc}
37
-	 */
38
-	public function get($key) {
39
-		if ($this->hasKey($key)) {
40
-			return $this->cachedData[$key];
41
-		}
42
-		return null;
43
-	}
35
+    /**
36
+     * {@inheritDoc}
37
+     */
38
+    public function get($key) {
39
+        if ($this->hasKey($key)) {
40
+            return $this->cachedData[$key];
41
+        }
42
+        return null;
43
+    }
44 44
 
45
-	/**
46
-	 * {@inheritDoc}
47
-	 */
48
-	public function set($key, $value, $ttl = 0) {
49
-		$this->cachedData[$key] = $value;
50
-		return true;
51
-	}
45
+    /**
46
+     * {@inheritDoc}
47
+     */
48
+    public function set($key, $value, $ttl = 0) {
49
+        $this->cachedData[$key] = $value;
50
+        return true;
51
+    }
52 52
 
53
-	/**
54
-	 * {@inheritDoc}
55
-	 */
56
-	public function hasKey($key) {
57
-		return isset($this->cachedData[$key]);
58
-	}
53
+    /**
54
+     * {@inheritDoc}
55
+     */
56
+    public function hasKey($key) {
57
+        return isset($this->cachedData[$key]);
58
+    }
59 59
 
60
-	/**
61
-	 * {@inheritDoc}
62
-	 */
63
-	public function remove($key) {
64
-		unset($this->cachedData[$key]);
65
-		return true;
66
-	}
60
+    /**
61
+     * {@inheritDoc}
62
+     */
63
+    public function remove($key) {
64
+        unset($this->cachedData[$key]);
65
+        return true;
66
+    }
67 67
 
68
-	/**
69
-	 * {@inheritDoc}
70
-	 */
71
-	public function clear($prefix = '') {
72
-		if ($prefix === '') {
73
-			$this->cachedData = [];
74
-			return true;
75
-		}
68
+    /**
69
+     * {@inheritDoc}
70
+     */
71
+    public function clear($prefix = '') {
72
+        if ($prefix === '') {
73
+            $this->cachedData = [];
74
+            return true;
75
+        }
76 76
 
77
-		foreach ($this->cachedData as $key => $value) {
78
-			if (strpos($key, $prefix) === 0) {
79
-				$this->remove($key);
80
-			}
81
-		}
82
-		return true;
83
-	}
77
+        foreach ($this->cachedData as $key => $value) {
78
+            if (strpos($key, $prefix) === 0) {
79
+                $this->remove($key);
80
+            }
81
+        }
82
+        return true;
83
+    }
84 84
 
85
-	/**
86
-	 * Set a value in the cache if it's not already stored
87
-	 *
88
-	 * @param string $key
89
-	 * @param mixed $value
90
-	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
91
-	 * @return bool
92
-	 */
93
-	public function add($key, $value, $ttl = 0) {
94
-		// since this cache is not shared race conditions aren't an issue
95
-		if ($this->hasKey($key)) {
96
-			return false;
97
-		} else {
98
-			return $this->set($key, $value, $ttl);
99
-		}
100
-	}
85
+    /**
86
+     * Set a value in the cache if it's not already stored
87
+     *
88
+     * @param string $key
89
+     * @param mixed $value
90
+     * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
91
+     * @return bool
92
+     */
93
+    public function add($key, $value, $ttl = 0) {
94
+        // since this cache is not shared race conditions aren't an issue
95
+        if ($this->hasKey($key)) {
96
+            return false;
97
+        } else {
98
+            return $this->set($key, $value, $ttl);
99
+        }
100
+    }
101 101
 
102
-	/**
103
-	 * Increase a stored number
104
-	 *
105
-	 * @param string $key
106
-	 * @param int $step
107
-	 * @return int | bool
108
-	 */
109
-	public function inc($key, $step = 1) {
110
-		$oldValue = $this->get($key);
111
-		if (is_int($oldValue)) {
112
-			$this->set($key, $oldValue + $step);
113
-			return $oldValue + $step;
114
-		} else {
115
-			$success = $this->add($key, $step);
116
-			return $success ? $step : false;
117
-		}
118
-	}
102
+    /**
103
+     * Increase a stored number
104
+     *
105
+     * @param string $key
106
+     * @param int $step
107
+     * @return int | bool
108
+     */
109
+    public function inc($key, $step = 1) {
110
+        $oldValue = $this->get($key);
111
+        if (is_int($oldValue)) {
112
+            $this->set($key, $oldValue + $step);
113
+            return $oldValue + $step;
114
+        } else {
115
+            $success = $this->add($key, $step);
116
+            return $success ? $step : false;
117
+        }
118
+    }
119 119
 
120
-	/**
121
-	 * Decrease a stored number
122
-	 *
123
-	 * @param string $key
124
-	 * @param int $step
125
-	 * @return int | bool
126
-	 */
127
-	public function dec($key, $step = 1) {
128
-		$oldValue = $this->get($key);
129
-		if (is_int($oldValue)) {
130
-			$this->set($key, $oldValue - $step);
131
-			return $oldValue - $step;
132
-		} else {
133
-			return false;
134
-		}
135
-	}
120
+    /**
121
+     * Decrease a stored number
122
+     *
123
+     * @param string $key
124
+     * @param int $step
125
+     * @return int | bool
126
+     */
127
+    public function dec($key, $step = 1) {
128
+        $oldValue = $this->get($key);
129
+        if (is_int($oldValue)) {
130
+            $this->set($key, $oldValue - $step);
131
+            return $oldValue - $step;
132
+        } else {
133
+            return false;
134
+        }
135
+    }
136 136
 
137
-	/**
138
-	 * Compare and set
139
-	 *
140
-	 * @param string $key
141
-	 * @param mixed $old
142
-	 * @param mixed $new
143
-	 * @return bool
144
-	 */
145
-	public function cas($key, $old, $new) {
146
-		if ($this->get($key) === $old) {
147
-			return $this->set($key, $new);
148
-		} else {
149
-			return false;
150
-		}
151
-	}
137
+    /**
138
+     * Compare and set
139
+     *
140
+     * @param string $key
141
+     * @param mixed $old
142
+     * @param mixed $new
143
+     * @return bool
144
+     */
145
+    public function cas($key, $old, $new) {
146
+        if ($this->get($key) === $old) {
147
+            return $this->set($key, $new);
148
+        } else {
149
+            return false;
150
+        }
151
+    }
152 152
 
153
-	/**
154
-	 * {@inheritDoc}
155
-	 */
156
-	static public function isAvailable() {
157
-		return true;
158
-	}
153
+    /**
154
+     * {@inheritDoc}
155
+     */
156
+    static public function isAvailable() {
157
+        return true;
158
+    }
159 159
 }
Please login to merge, or discard this patch.
apps/files_external/lib/Lib/Storage/SMB.php 3 patches
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -498,6 +498,9 @@
 block discarded – undo
498 498
 		});
499 499
 	}
500 500
 
501
+	/**
502
+	 * @param string $path
503
+	 */
501 504
 	public function notify($path) {
502 505
 		$path = '/' . ltrim($path, '/');
503 506
 		$shareNotifyHandler = $this->share->notify($this->buildPath($path));
Please login to merge, or discard this patch.
Indentation   +470 added lines, -470 removed lines patch added patch discarded remove patch
@@ -55,474 +55,474 @@
 block discarded – undo
55 55
 use OCP\Util;
56 56
 
57 57
 class SMB extends Common implements INotifyStorage {
58
-	/**
59
-	 * @var \Icewind\SMB\Server
60
-	 */
61
-	protected $server;
62
-
63
-	/**
64
-	 * @var \Icewind\SMB\Share
65
-	 */
66
-	protected $share;
67
-
68
-	/**
69
-	 * @var string
70
-	 */
71
-	protected $root;
72
-
73
-	/**
74
-	 * @var \Icewind\SMB\FileInfo[]
75
-	 */
76
-	protected $statCache;
77
-
78
-	public function __construct($params) {
79
-		if (isset($params['host']) && isset($params['user']) && isset($params['password']) && isset($params['share'])) {
80
-			if (Server::NativeAvailable()) {
81
-				$this->server = new NativeServer($params['host'], $params['user'], $params['password']);
82
-			} else {
83
-				$this->server = new Server($params['host'], $params['user'], $params['password']);
84
-			}
85
-			$this->share = $this->server->getShare(trim($params['share'], '/'));
86
-
87
-			$this->root = $params['root'] ?? '/';
88
-			$this->root = '/' . ltrim($this->root, '/');
89
-			$this->root = rtrim($this->root, '/') . '/';
90
-		} else {
91
-			throw new \Exception('Invalid configuration');
92
-		}
93
-		$this->statCache = new CappedMemoryCache();
94
-		parent::__construct($params);
95
-	}
96
-
97
-	/**
98
-	 * @return string
99
-	 */
100
-	public function getId() {
101
-		// FIXME: double slash to keep compatible with the old storage ids,
102
-		// failure to do so will lead to creation of a new storage id and
103
-		// loss of shares from the storage
104
-		return 'smb::' . $this->server->getUser() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root;
105
-	}
106
-
107
-	/**
108
-	 * @param string $path
109
-	 * @return string
110
-	 */
111
-	protected function buildPath($path) {
112
-		return Filesystem::normalizePath($this->root . '/' . $path, true, false, true);
113
-	}
114
-
115
-	protected function relativePath($fullPath) {
116
-		if ($fullPath === $this->root) {
117
-			return '';
118
-		} else if (substr($fullPath, 0, strlen($this->root)) === $this->root) {
119
-			return substr($fullPath, strlen($this->root));
120
-		} else {
121
-			return null;
122
-		}
123
-	}
124
-
125
-	/**
126
-	 * @param string $path
127
-	 * @return \Icewind\SMB\IFileInfo
128
-	 * @throws StorageNotAvailableException
129
-	 */
130
-	protected function getFileInfo($path) {
131
-		try {
132
-			$path = $this->buildPath($path);
133
-			if (!isset($this->statCache[$path])) {
134
-				$this->statCache[$path] = $this->share->stat($path);
135
-			}
136
-			return $this->statCache[$path];
137
-		} catch (ConnectException $e) {
138
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
139
-		}
140
-	}
141
-
142
-	/**
143
-	 * @param string $path
144
-	 * @return \Icewind\SMB\IFileInfo[]
145
-	 * @throws StorageNotAvailableException
146
-	 */
147
-	protected function getFolderContents($path) {
148
-		try {
149
-			$path = $this->buildPath($path);
150
-			$files = $this->share->dir($path);
151
-			foreach ($files as $file) {
152
-				$this->statCache[$path . '/' . $file->getName()] = $file;
153
-			}
154
-			return array_filter($files, function (IFileInfo $file) {
155
-				return !$file->isHidden();
156
-			});
157
-		} catch (ConnectException $e) {
158
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
159
-		}
160
-	}
161
-
162
-	/**
163
-	 * @param \Icewind\SMB\IFileInfo $info
164
-	 * @return array
165
-	 */
166
-	protected function formatInfo($info) {
167
-		$result = [
168
-			'size' => $info->getSize(),
169
-			'mtime' => $info->getMTime(),
170
-		];
171
-		if ($info->isDirectory()) {
172
-			$result['type'] = 'dir';
173
-		} else {
174
-			$result['type'] = 'file';
175
-		}
176
-		return $result;
177
-	}
178
-
179
-	/**
180
-	 * Rename the files. If the source or the target is the root, the rename won't happen.
181
-	 *
182
-	 * @param string $source the old name of the path
183
-	 * @param string $target the new name of the path
184
-	 * @return bool true if the rename is successful, false otherwise
185
-	 */
186
-	public function rename($source, $target) {
187
-		if ($this->isRootDir($source) || $this->isRootDir($target)) {
188
-			return false;
189
-		}
190
-
191
-		$absoluteSource = $this->buildPath($source);
192
-		$absoluteTarget = $this->buildPath($target);
193
-		try {
194
-			$result = $this->share->rename($absoluteSource, $absoluteTarget);
195
-		} catch (AlreadyExistsException $e) {
196
-			$this->remove($target);
197
-			$result = $this->share->rename($absoluteSource, $absoluteTarget);
198
-		} catch (\Exception $e) {
199
-			\OC::$server->getLogger()->logException($e, ['level' => Util::WARN]);
200
-			return false;
201
-		}
202
-		unset($this->statCache[$absoluteSource], $this->statCache[$absoluteTarget]);
203
-		return $result;
204
-	}
205
-
206
-	public function stat($path) {
207
-		try {
208
-			$result = $this->formatInfo($this->getFileInfo($path));
209
-		} catch (ForbiddenException $e) {
210
-			return false;
211
-		} catch (NotFoundException $e) {
212
-			return false;
213
-		}
214
-		if ($this->remoteIsShare() && $this->isRootDir($path)) {
215
-			$result['mtime'] = $this->shareMTime();
216
-		}
217
-		return $result;
218
-	}
219
-
220
-	/**
221
-	 * get the best guess for the modification time of the share
222
-	 *
223
-	 * @return int
224
-	 */
225
-	private function shareMTime() {
226
-		$highestMTime = 0;
227
-		$files = $this->share->dir($this->root);
228
-		foreach ($files as $fileInfo) {
229
-			if ($fileInfo->getMTime() > $highestMTime) {
230
-				$highestMTime = $fileInfo->getMTime();
231
-			}
232
-		}
233
-		return $highestMTime;
234
-	}
235
-
236
-	/**
237
-	 * Check if the path is our root dir (not the smb one)
238
-	 *
239
-	 * @param string $path the path
240
-	 * @return bool
241
-	 */
242
-	private function isRootDir($path) {
243
-		return $path === '' || $path === '/' || $path === '.';
244
-	}
245
-
246
-	/**
247
-	 * Check if our root points to a smb share
248
-	 *
249
-	 * @return bool true if our root points to a share false otherwise
250
-	 */
251
-	private function remoteIsShare() {
252
-		return $this->share->getName() && (!$this->root || $this->root === '/');
253
-	}
254
-
255
-	/**
256
-	 * @param string $path
257
-	 * @return bool
258
-	 */
259
-	public function unlink($path) {
260
-		if ($this->isRootDir($path)) {
261
-			return false;
262
-		}
263
-
264
-		try {
265
-			if ($this->is_dir($path)) {
266
-				return $this->rmdir($path);
267
-			} else {
268
-				$path = $this->buildPath($path);
269
-				unset($this->statCache[$path]);
270
-				$this->share->del($path);
271
-				return true;
272
-			}
273
-		} catch (NotFoundException $e) {
274
-			return false;
275
-		} catch (ForbiddenException $e) {
276
-			return false;
277
-		} catch (ConnectException $e) {
278
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
279
-		}
280
-	}
281
-
282
-	/**
283
-	 * check if a file or folder has been updated since $time
284
-	 *
285
-	 * @param string $path
286
-	 * @param int $time
287
-	 * @return bool
288
-	 */
289
-	public function hasUpdated($path, $time) {
290
-		if (!$path and $this->root === '/') {
291
-			// mtime doesn't work for shares, but giving the nature of the backend,
292
-			// doing a full update is still just fast enough
293
-			return true;
294
-		} else {
295
-			$actualTime = $this->filemtime($path);
296
-			return $actualTime > $time;
297
-		}
298
-	}
299
-
300
-	/**
301
-	 * @param string $path
302
-	 * @param string $mode
303
-	 * @return resource|false
304
-	 */
305
-	public function fopen($path, $mode) {
306
-		$fullPath = $this->buildPath($path);
307
-		try {
308
-			switch ($mode) {
309
-				case 'r':
310
-				case 'rb':
311
-					if (!$this->file_exists($path)) {
312
-						return false;
313
-					}
314
-					return $this->share->read($fullPath);
315
-				case 'w':
316
-				case 'wb':
317
-					$source = $this->share->write($fullPath);
318
-					return CallBackWrapper::wrap($source, null, null, function () use ($fullPath) {
319
-						unset($this->statCache[$fullPath]);
320
-					});
321
-				case 'a':
322
-				case 'ab':
323
-				case 'r+':
324
-				case 'w+':
325
-				case 'wb+':
326
-				case 'a+':
327
-				case 'x':
328
-				case 'x+':
329
-				case 'c':
330
-				case 'c+':
331
-					//emulate these
332
-					if (strrpos($path, '.') !== false) {
333
-						$ext = substr($path, strrpos($path, '.'));
334
-					} else {
335
-						$ext = '';
336
-					}
337
-					if ($this->file_exists($path)) {
338
-						if (!$this->isUpdatable($path)) {
339
-							return false;
340
-						}
341
-						$tmpFile = $this->getCachedFile($path);
342
-					} else {
343
-						if (!$this->isCreatable(dirname($path))) {
344
-							return false;
345
-						}
346
-						$tmpFile = \OCP\Files::tmpFile($ext);
347
-					}
348
-					$source = fopen($tmpFile, $mode);
349
-					$share = $this->share;
350
-					return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath, $share) {
351
-						unset($this->statCache[$fullPath]);
352
-						$share->put($tmpFile, $fullPath);
353
-						unlink($tmpFile);
354
-					});
355
-			}
356
-			return false;
357
-		} catch (NotFoundException $e) {
358
-			return false;
359
-		} catch (ForbiddenException $e) {
360
-			return false;
361
-		} catch (ConnectException $e) {
362
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
363
-		}
364
-	}
365
-
366
-	public function rmdir($path) {
367
-		if ($this->isRootDir($path)) {
368
-			return false;
369
-		}
370
-
371
-		try {
372
-			$this->statCache = array();
373
-			$content = $this->share->dir($this->buildPath($path));
374
-			foreach ($content as $file) {
375
-				if ($file->isDirectory()) {
376
-					$this->rmdir($path . '/' . $file->getName());
377
-				} else {
378
-					$this->share->del($file->getPath());
379
-				}
380
-			}
381
-			$this->share->rmdir($this->buildPath($path));
382
-			return true;
383
-		} catch (NotFoundException $e) {
384
-			return false;
385
-		} catch (ForbiddenException $e) {
386
-			return false;
387
-		} catch (ConnectException $e) {
388
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
389
-		}
390
-	}
391
-
392
-	public function touch($path, $time = null) {
393
-		try {
394
-			if (!$this->file_exists($path)) {
395
-				$fh = $this->share->write($this->buildPath($path));
396
-				fclose($fh);
397
-				return true;
398
-			}
399
-			return false;
400
-		} catch (ConnectException $e) {
401
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
402
-		}
403
-	}
404
-
405
-	public function opendir($path) {
406
-		try {
407
-			$files = $this->getFolderContents($path);
408
-		} catch (NotFoundException $e) {
409
-			return false;
410
-		} catch (ForbiddenException $e) {
411
-			return false;
412
-		}
413
-		$names = array_map(function ($info) {
414
-			/** @var \Icewind\SMB\IFileInfo $info */
415
-			return $info->getName();
416
-		}, $files);
417
-		return IteratorDirectory::wrap($names);
418
-	}
419
-
420
-	public function filetype($path) {
421
-		try {
422
-			return $this->getFileInfo($path)->isDirectory() ? 'dir' : 'file';
423
-		} catch (NotFoundException $e) {
424
-			return false;
425
-		} catch (ForbiddenException $e) {
426
-			return false;
427
-		}
428
-	}
429
-
430
-	public function mkdir($path) {
431
-		$path = $this->buildPath($path);
432
-		try {
433
-			$this->share->mkdir($path);
434
-			return true;
435
-		} catch (ConnectException $e) {
436
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
437
-		} catch (Exception $e) {
438
-			return false;
439
-		}
440
-	}
441
-
442
-	public function file_exists($path) {
443
-		try {
444
-			$this->getFileInfo($path);
445
-			return true;
446
-		} catch (NotFoundException $e) {
447
-			return false;
448
-		} catch (ForbiddenException $e) {
449
-			return false;
450
-		} catch (ConnectException $e) {
451
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
452
-		}
453
-	}
454
-
455
-	public function isReadable($path) {
456
-		try {
457
-			$info = $this->getFileInfo($path);
458
-			return !$info->isHidden();
459
-		} catch (NotFoundException $e) {
460
-			return false;
461
-		} catch (ForbiddenException $e) {
462
-			return false;
463
-		}
464
-	}
465
-
466
-	public function isUpdatable($path) {
467
-		try {
468
-			$info = $this->getFileInfo($path);
469
-			// following windows behaviour for read-only folders: they can be written into
470
-			// (https://support.microsoft.com/en-us/kb/326549 - "cause" section)
471
-			return !$info->isHidden() && (!$info->isReadOnly() || $this->is_dir($path));
472
-		} catch (NotFoundException $e) {
473
-			return false;
474
-		} catch (ForbiddenException $e) {
475
-			return false;
476
-		}
477
-	}
478
-
479
-	public function isDeletable($path) {
480
-		try {
481
-			$info = $this->getFileInfo($path);
482
-			return !$info->isHidden() && !$info->isReadOnly();
483
-		} catch (NotFoundException $e) {
484
-			return false;
485
-		} catch (ForbiddenException $e) {
486
-			return false;
487
-		}
488
-	}
489
-
490
-	/**
491
-	 * check if smbclient is installed
492
-	 */
493
-	public static function checkDependencies() {
494
-		return (
495
-			(bool)\OC_Helper::findBinaryPath('smbclient')
496
-			|| Server::NativeAvailable()
497
-		) ? true : ['smbclient'];
498
-	}
499
-
500
-	/**
501
-	 * Test a storage for availability
502
-	 *
503
-	 * @return bool
504
-	 */
505
-	public function test() {
506
-		try {
507
-			return parent::test();
508
-		} catch (Exception $e) {
509
-			return false;
510
-		}
511
-	}
512
-
513
-	public function listen($path, callable $callback) {
514
-		$this->notify($path)->listen(function (IChange $change) use ($callback) {
515
-			if ($change instanceof IRenameChange) {
516
-				return $callback($change->getType(), $change->getPath(), $change->getTargetPath());
517
-			} else {
518
-				return $callback($change->getType(), $change->getPath());
519
-			}
520
-		});
521
-	}
522
-
523
-	public function notify($path) {
524
-		$path = '/' . ltrim($path, '/');
525
-		$shareNotifyHandler = $this->share->notify($this->buildPath($path));
526
-		return new SMBNotifyHandler($shareNotifyHandler, $this->root);
527
-	}
58
+    /**
59
+     * @var \Icewind\SMB\Server
60
+     */
61
+    protected $server;
62
+
63
+    /**
64
+     * @var \Icewind\SMB\Share
65
+     */
66
+    protected $share;
67
+
68
+    /**
69
+     * @var string
70
+     */
71
+    protected $root;
72
+
73
+    /**
74
+     * @var \Icewind\SMB\FileInfo[]
75
+     */
76
+    protected $statCache;
77
+
78
+    public function __construct($params) {
79
+        if (isset($params['host']) && isset($params['user']) && isset($params['password']) && isset($params['share'])) {
80
+            if (Server::NativeAvailable()) {
81
+                $this->server = new NativeServer($params['host'], $params['user'], $params['password']);
82
+            } else {
83
+                $this->server = new Server($params['host'], $params['user'], $params['password']);
84
+            }
85
+            $this->share = $this->server->getShare(trim($params['share'], '/'));
86
+
87
+            $this->root = $params['root'] ?? '/';
88
+            $this->root = '/' . ltrim($this->root, '/');
89
+            $this->root = rtrim($this->root, '/') . '/';
90
+        } else {
91
+            throw new \Exception('Invalid configuration');
92
+        }
93
+        $this->statCache = new CappedMemoryCache();
94
+        parent::__construct($params);
95
+    }
96
+
97
+    /**
98
+     * @return string
99
+     */
100
+    public function getId() {
101
+        // FIXME: double slash to keep compatible with the old storage ids,
102
+        // failure to do so will lead to creation of a new storage id and
103
+        // loss of shares from the storage
104
+        return 'smb::' . $this->server->getUser() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root;
105
+    }
106
+
107
+    /**
108
+     * @param string $path
109
+     * @return string
110
+     */
111
+    protected function buildPath($path) {
112
+        return Filesystem::normalizePath($this->root . '/' . $path, true, false, true);
113
+    }
114
+
115
+    protected function relativePath($fullPath) {
116
+        if ($fullPath === $this->root) {
117
+            return '';
118
+        } else if (substr($fullPath, 0, strlen($this->root)) === $this->root) {
119
+            return substr($fullPath, strlen($this->root));
120
+        } else {
121
+            return null;
122
+        }
123
+    }
124
+
125
+    /**
126
+     * @param string $path
127
+     * @return \Icewind\SMB\IFileInfo
128
+     * @throws StorageNotAvailableException
129
+     */
130
+    protected function getFileInfo($path) {
131
+        try {
132
+            $path = $this->buildPath($path);
133
+            if (!isset($this->statCache[$path])) {
134
+                $this->statCache[$path] = $this->share->stat($path);
135
+            }
136
+            return $this->statCache[$path];
137
+        } catch (ConnectException $e) {
138
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
139
+        }
140
+    }
141
+
142
+    /**
143
+     * @param string $path
144
+     * @return \Icewind\SMB\IFileInfo[]
145
+     * @throws StorageNotAvailableException
146
+     */
147
+    protected function getFolderContents($path) {
148
+        try {
149
+            $path = $this->buildPath($path);
150
+            $files = $this->share->dir($path);
151
+            foreach ($files as $file) {
152
+                $this->statCache[$path . '/' . $file->getName()] = $file;
153
+            }
154
+            return array_filter($files, function (IFileInfo $file) {
155
+                return !$file->isHidden();
156
+            });
157
+        } catch (ConnectException $e) {
158
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
159
+        }
160
+    }
161
+
162
+    /**
163
+     * @param \Icewind\SMB\IFileInfo $info
164
+     * @return array
165
+     */
166
+    protected function formatInfo($info) {
167
+        $result = [
168
+            'size' => $info->getSize(),
169
+            'mtime' => $info->getMTime(),
170
+        ];
171
+        if ($info->isDirectory()) {
172
+            $result['type'] = 'dir';
173
+        } else {
174
+            $result['type'] = 'file';
175
+        }
176
+        return $result;
177
+    }
178
+
179
+    /**
180
+     * Rename the files. If the source or the target is the root, the rename won't happen.
181
+     *
182
+     * @param string $source the old name of the path
183
+     * @param string $target the new name of the path
184
+     * @return bool true if the rename is successful, false otherwise
185
+     */
186
+    public function rename($source, $target) {
187
+        if ($this->isRootDir($source) || $this->isRootDir($target)) {
188
+            return false;
189
+        }
190
+
191
+        $absoluteSource = $this->buildPath($source);
192
+        $absoluteTarget = $this->buildPath($target);
193
+        try {
194
+            $result = $this->share->rename($absoluteSource, $absoluteTarget);
195
+        } catch (AlreadyExistsException $e) {
196
+            $this->remove($target);
197
+            $result = $this->share->rename($absoluteSource, $absoluteTarget);
198
+        } catch (\Exception $e) {
199
+            \OC::$server->getLogger()->logException($e, ['level' => Util::WARN]);
200
+            return false;
201
+        }
202
+        unset($this->statCache[$absoluteSource], $this->statCache[$absoluteTarget]);
203
+        return $result;
204
+    }
205
+
206
+    public function stat($path) {
207
+        try {
208
+            $result = $this->formatInfo($this->getFileInfo($path));
209
+        } catch (ForbiddenException $e) {
210
+            return false;
211
+        } catch (NotFoundException $e) {
212
+            return false;
213
+        }
214
+        if ($this->remoteIsShare() && $this->isRootDir($path)) {
215
+            $result['mtime'] = $this->shareMTime();
216
+        }
217
+        return $result;
218
+    }
219
+
220
+    /**
221
+     * get the best guess for the modification time of the share
222
+     *
223
+     * @return int
224
+     */
225
+    private function shareMTime() {
226
+        $highestMTime = 0;
227
+        $files = $this->share->dir($this->root);
228
+        foreach ($files as $fileInfo) {
229
+            if ($fileInfo->getMTime() > $highestMTime) {
230
+                $highestMTime = $fileInfo->getMTime();
231
+            }
232
+        }
233
+        return $highestMTime;
234
+    }
235
+
236
+    /**
237
+     * Check if the path is our root dir (not the smb one)
238
+     *
239
+     * @param string $path the path
240
+     * @return bool
241
+     */
242
+    private function isRootDir($path) {
243
+        return $path === '' || $path === '/' || $path === '.';
244
+    }
245
+
246
+    /**
247
+     * Check if our root points to a smb share
248
+     *
249
+     * @return bool true if our root points to a share false otherwise
250
+     */
251
+    private function remoteIsShare() {
252
+        return $this->share->getName() && (!$this->root || $this->root === '/');
253
+    }
254
+
255
+    /**
256
+     * @param string $path
257
+     * @return bool
258
+     */
259
+    public function unlink($path) {
260
+        if ($this->isRootDir($path)) {
261
+            return false;
262
+        }
263
+
264
+        try {
265
+            if ($this->is_dir($path)) {
266
+                return $this->rmdir($path);
267
+            } else {
268
+                $path = $this->buildPath($path);
269
+                unset($this->statCache[$path]);
270
+                $this->share->del($path);
271
+                return true;
272
+            }
273
+        } catch (NotFoundException $e) {
274
+            return false;
275
+        } catch (ForbiddenException $e) {
276
+            return false;
277
+        } catch (ConnectException $e) {
278
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
279
+        }
280
+    }
281
+
282
+    /**
283
+     * check if a file or folder has been updated since $time
284
+     *
285
+     * @param string $path
286
+     * @param int $time
287
+     * @return bool
288
+     */
289
+    public function hasUpdated($path, $time) {
290
+        if (!$path and $this->root === '/') {
291
+            // mtime doesn't work for shares, but giving the nature of the backend,
292
+            // doing a full update is still just fast enough
293
+            return true;
294
+        } else {
295
+            $actualTime = $this->filemtime($path);
296
+            return $actualTime > $time;
297
+        }
298
+    }
299
+
300
+    /**
301
+     * @param string $path
302
+     * @param string $mode
303
+     * @return resource|false
304
+     */
305
+    public function fopen($path, $mode) {
306
+        $fullPath = $this->buildPath($path);
307
+        try {
308
+            switch ($mode) {
309
+                case 'r':
310
+                case 'rb':
311
+                    if (!$this->file_exists($path)) {
312
+                        return false;
313
+                    }
314
+                    return $this->share->read($fullPath);
315
+                case 'w':
316
+                case 'wb':
317
+                    $source = $this->share->write($fullPath);
318
+                    return CallBackWrapper::wrap($source, null, null, function () use ($fullPath) {
319
+                        unset($this->statCache[$fullPath]);
320
+                    });
321
+                case 'a':
322
+                case 'ab':
323
+                case 'r+':
324
+                case 'w+':
325
+                case 'wb+':
326
+                case 'a+':
327
+                case 'x':
328
+                case 'x+':
329
+                case 'c':
330
+                case 'c+':
331
+                    //emulate these
332
+                    if (strrpos($path, '.') !== false) {
333
+                        $ext = substr($path, strrpos($path, '.'));
334
+                    } else {
335
+                        $ext = '';
336
+                    }
337
+                    if ($this->file_exists($path)) {
338
+                        if (!$this->isUpdatable($path)) {
339
+                            return false;
340
+                        }
341
+                        $tmpFile = $this->getCachedFile($path);
342
+                    } else {
343
+                        if (!$this->isCreatable(dirname($path))) {
344
+                            return false;
345
+                        }
346
+                        $tmpFile = \OCP\Files::tmpFile($ext);
347
+                    }
348
+                    $source = fopen($tmpFile, $mode);
349
+                    $share = $this->share;
350
+                    return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath, $share) {
351
+                        unset($this->statCache[$fullPath]);
352
+                        $share->put($tmpFile, $fullPath);
353
+                        unlink($tmpFile);
354
+                    });
355
+            }
356
+            return false;
357
+        } catch (NotFoundException $e) {
358
+            return false;
359
+        } catch (ForbiddenException $e) {
360
+            return false;
361
+        } catch (ConnectException $e) {
362
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
363
+        }
364
+    }
365
+
366
+    public function rmdir($path) {
367
+        if ($this->isRootDir($path)) {
368
+            return false;
369
+        }
370
+
371
+        try {
372
+            $this->statCache = array();
373
+            $content = $this->share->dir($this->buildPath($path));
374
+            foreach ($content as $file) {
375
+                if ($file->isDirectory()) {
376
+                    $this->rmdir($path . '/' . $file->getName());
377
+                } else {
378
+                    $this->share->del($file->getPath());
379
+                }
380
+            }
381
+            $this->share->rmdir($this->buildPath($path));
382
+            return true;
383
+        } catch (NotFoundException $e) {
384
+            return false;
385
+        } catch (ForbiddenException $e) {
386
+            return false;
387
+        } catch (ConnectException $e) {
388
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
389
+        }
390
+    }
391
+
392
+    public function touch($path, $time = null) {
393
+        try {
394
+            if (!$this->file_exists($path)) {
395
+                $fh = $this->share->write($this->buildPath($path));
396
+                fclose($fh);
397
+                return true;
398
+            }
399
+            return false;
400
+        } catch (ConnectException $e) {
401
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
402
+        }
403
+    }
404
+
405
+    public function opendir($path) {
406
+        try {
407
+            $files = $this->getFolderContents($path);
408
+        } catch (NotFoundException $e) {
409
+            return false;
410
+        } catch (ForbiddenException $e) {
411
+            return false;
412
+        }
413
+        $names = array_map(function ($info) {
414
+            /** @var \Icewind\SMB\IFileInfo $info */
415
+            return $info->getName();
416
+        }, $files);
417
+        return IteratorDirectory::wrap($names);
418
+    }
419
+
420
+    public function filetype($path) {
421
+        try {
422
+            return $this->getFileInfo($path)->isDirectory() ? 'dir' : 'file';
423
+        } catch (NotFoundException $e) {
424
+            return false;
425
+        } catch (ForbiddenException $e) {
426
+            return false;
427
+        }
428
+    }
429
+
430
+    public function mkdir($path) {
431
+        $path = $this->buildPath($path);
432
+        try {
433
+            $this->share->mkdir($path);
434
+            return true;
435
+        } catch (ConnectException $e) {
436
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
437
+        } catch (Exception $e) {
438
+            return false;
439
+        }
440
+    }
441
+
442
+    public function file_exists($path) {
443
+        try {
444
+            $this->getFileInfo($path);
445
+            return true;
446
+        } catch (NotFoundException $e) {
447
+            return false;
448
+        } catch (ForbiddenException $e) {
449
+            return false;
450
+        } catch (ConnectException $e) {
451
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
452
+        }
453
+    }
454
+
455
+    public function isReadable($path) {
456
+        try {
457
+            $info = $this->getFileInfo($path);
458
+            return !$info->isHidden();
459
+        } catch (NotFoundException $e) {
460
+            return false;
461
+        } catch (ForbiddenException $e) {
462
+            return false;
463
+        }
464
+    }
465
+
466
+    public function isUpdatable($path) {
467
+        try {
468
+            $info = $this->getFileInfo($path);
469
+            // following windows behaviour for read-only folders: they can be written into
470
+            // (https://support.microsoft.com/en-us/kb/326549 - "cause" section)
471
+            return !$info->isHidden() && (!$info->isReadOnly() || $this->is_dir($path));
472
+        } catch (NotFoundException $e) {
473
+            return false;
474
+        } catch (ForbiddenException $e) {
475
+            return false;
476
+        }
477
+    }
478
+
479
+    public function isDeletable($path) {
480
+        try {
481
+            $info = $this->getFileInfo($path);
482
+            return !$info->isHidden() && !$info->isReadOnly();
483
+        } catch (NotFoundException $e) {
484
+            return false;
485
+        } catch (ForbiddenException $e) {
486
+            return false;
487
+        }
488
+    }
489
+
490
+    /**
491
+     * check if smbclient is installed
492
+     */
493
+    public static function checkDependencies() {
494
+        return (
495
+            (bool)\OC_Helper::findBinaryPath('smbclient')
496
+            || Server::NativeAvailable()
497
+        ) ? true : ['smbclient'];
498
+    }
499
+
500
+    /**
501
+     * Test a storage for availability
502
+     *
503
+     * @return bool
504
+     */
505
+    public function test() {
506
+        try {
507
+            return parent::test();
508
+        } catch (Exception $e) {
509
+            return false;
510
+        }
511
+    }
512
+
513
+    public function listen($path, callable $callback) {
514
+        $this->notify($path)->listen(function (IChange $change) use ($callback) {
515
+            if ($change instanceof IRenameChange) {
516
+                return $callback($change->getType(), $change->getPath(), $change->getTargetPath());
517
+            } else {
518
+                return $callback($change->getType(), $change->getPath());
519
+            }
520
+        });
521
+    }
522
+
523
+    public function notify($path) {
524
+        $path = '/' . ltrim($path, '/');
525
+        $shareNotifyHandler = $this->share->notify($this->buildPath($path));
526
+        return new SMBNotifyHandler($shareNotifyHandler, $this->root);
527
+    }
528 528
 }
Please login to merge, or discard this patch.
Spacing   +13 added lines, -13 removed lines patch added patch discarded remove patch
@@ -85,8 +85,8 @@  discard block
 block discarded – undo
85 85
 			$this->share = $this->server->getShare(trim($params['share'], '/'));
86 86
 
87 87
 			$this->root = $params['root'] ?? '/';
88
-			$this->root = '/' . ltrim($this->root, '/');
89
-			$this->root = rtrim($this->root, '/') . '/';
88
+			$this->root = '/'.ltrim($this->root, '/');
89
+			$this->root = rtrim($this->root, '/').'/';
90 90
 		} else {
91 91
 			throw new \Exception('Invalid configuration');
92 92
 		}
@@ -101,7 +101,7 @@  discard block
 block discarded – undo
101 101
 		// FIXME: double slash to keep compatible with the old storage ids,
102 102
 		// failure to do so will lead to creation of a new storage id and
103 103
 		// loss of shares from the storage
104
-		return 'smb::' . $this->server->getUser() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root;
104
+		return 'smb::'.$this->server->getUser().'@'.$this->server->getHost().'//'.$this->share->getName().'/'.$this->root;
105 105
 	}
106 106
 
107 107
 	/**
@@ -109,7 +109,7 @@  discard block
 block discarded – undo
109 109
 	 * @return string
110 110
 	 */
111 111
 	protected function buildPath($path) {
112
-		return Filesystem::normalizePath($this->root . '/' . $path, true, false, true);
112
+		return Filesystem::normalizePath($this->root.'/'.$path, true, false, true);
113 113
 	}
114 114
 
115 115
 	protected function relativePath($fullPath) {
@@ -149,9 +149,9 @@  discard block
 block discarded – undo
149 149
 			$path = $this->buildPath($path);
150 150
 			$files = $this->share->dir($path);
151 151
 			foreach ($files as $file) {
152
-				$this->statCache[$path . '/' . $file->getName()] = $file;
152
+				$this->statCache[$path.'/'.$file->getName()] = $file;
153 153
 			}
154
-			return array_filter($files, function (IFileInfo $file) {
154
+			return array_filter($files, function(IFileInfo $file) {
155 155
 				return !$file->isHidden();
156 156
 			});
157 157
 		} catch (ConnectException $e) {
@@ -315,7 +315,7 @@  discard block
 block discarded – undo
315 315
 				case 'w':
316 316
 				case 'wb':
317 317
 					$source = $this->share->write($fullPath);
318
-					return CallBackWrapper::wrap($source, null, null, function () use ($fullPath) {
318
+					return CallBackWrapper::wrap($source, null, null, function() use ($fullPath) {
319 319
 						unset($this->statCache[$fullPath]);
320 320
 					});
321 321
 				case 'a':
@@ -347,7 +347,7 @@  discard block
 block discarded – undo
347 347
 					}
348 348
 					$source = fopen($tmpFile, $mode);
349 349
 					$share = $this->share;
350
-					return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath, $share) {
350
+					return CallbackWrapper::wrap($source, null, null, function() use ($tmpFile, $fullPath, $share) {
351 351
 						unset($this->statCache[$fullPath]);
352 352
 						$share->put($tmpFile, $fullPath);
353 353
 						unlink($tmpFile);
@@ -373,7 +373,7 @@  discard block
 block discarded – undo
373 373
 			$content = $this->share->dir($this->buildPath($path));
374 374
 			foreach ($content as $file) {
375 375
 				if ($file->isDirectory()) {
376
-					$this->rmdir($path . '/' . $file->getName());
376
+					$this->rmdir($path.'/'.$file->getName());
377 377
 				} else {
378 378
 					$this->share->del($file->getPath());
379 379
 				}
@@ -410,7 +410,7 @@  discard block
 block discarded – undo
410 410
 		} catch (ForbiddenException $e) {
411 411
 			return false;
412 412
 		}
413
-		$names = array_map(function ($info) {
413
+		$names = array_map(function($info) {
414 414
 			/** @var \Icewind\SMB\IFileInfo $info */
415 415
 			return $info->getName();
416 416
 		}, $files);
@@ -492,7 +492,7 @@  discard block
 block discarded – undo
492 492
 	 */
493 493
 	public static function checkDependencies() {
494 494
 		return (
495
-			(bool)\OC_Helper::findBinaryPath('smbclient')
495
+			(bool) \OC_Helper::findBinaryPath('smbclient')
496 496
 			|| Server::NativeAvailable()
497 497
 		) ? true : ['smbclient'];
498 498
 	}
@@ -511,7 +511,7 @@  discard block
 block discarded – undo
511 511
 	}
512 512
 
513 513
 	public function listen($path, callable $callback) {
514
-		$this->notify($path)->listen(function (IChange $change) use ($callback) {
514
+		$this->notify($path)->listen(function(IChange $change) use ($callback) {
515 515
 			if ($change instanceof IRenameChange) {
516 516
 				return $callback($change->getType(), $change->getPath(), $change->getTargetPath());
517 517
 			} else {
@@ -521,7 +521,7 @@  discard block
 block discarded – undo
521 521
 	}
522 522
 
523 523
 	public function notify($path) {
524
-		$path = '/' . ltrim($path, '/');
524
+		$path = '/'.ltrim($path, '/');
525 525
 		$shareNotifyHandler = $this->share->notify($this->buildPath($path));
526 526
 		return new SMBNotifyHandler($shareNotifyHandler, $this->root);
527 527
 	}
Please login to merge, or discard this patch.
apps/user_ldap/lib/Controller/RenewPasswordController.php 3 patches
Unused Use Statements   -1 removed lines patch added patch discarded remove patch
@@ -23,7 +23,6 @@
 block discarded – undo
23 23
 namespace OCA\User_LDAP\Controller;
24 24
 
25 25
 use OC\HintException;
26
-use OC_Util;
27 26
 use OCP\AppFramework\Controller;
28 27
 use OCP\AppFramework\Http\RedirectResponse;
29 28
 use OCP\AppFramework\Http\TemplateResponse;
Please login to merge, or discard this patch.
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -85,7 +85,7 @@  discard block
 block discarded – undo
85 85
 	 * @return TemplateResponse|RedirectResponse
86 86
 	 */
87 87
 	public function showRenewPasswordForm($user) {
88
-		if($this->config->getUserValue($user, 'user_ldap', 'needsPasswordReset') !== 'true') {
88
+		if ($this->config->getUserValue($user, 'user_ldap', 'needsPasswordReset') !== 'true') {
89 89
 			return new RedirectResponse($this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm'));
90 90
 		}
91 91
 		$parameters = [];
@@ -129,7 +129,7 @@  discard block
 block discarded – undo
129 129
 	 * @return RedirectResponse
130 130
 	 */
131 131
 	public function tryRenewPassword($user, $oldPassword, $newPassword) {
132
-		if($this->config->getUserValue($user, 'user_ldap', 'needsPasswordReset') !== 'true') {
132
+		if ($this->config->getUserValue($user, 'user_ldap', 'needsPasswordReset') !== 'true') {
133 133
 			return new RedirectResponse($this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm'));
134 134
 		}
135 135
 		$args = !is_null($user) ? ['user' => $user] : [];
Please login to merge, or discard this patch.
Indentation   +129 added lines, -129 removed lines patch added patch discarded remove patch
@@ -37,144 +37,144 @@
 block discarded – undo
37 37
 use OCP\IUserManager;
38 38
 
39 39
 class RenewPasswordController extends Controller {
40
-	/** @var IUserManager */
41
-	private $userManager;
42
-	/** @var IConfig */
43
-	private $config;
44
-	/** @var IL10N */
45
-	protected $l10n;
46
-	/** @var ISession */
47
-	private $session;
48
-	/** @var IURLGenerator */
49
-	private $urlGenerator;
40
+    /** @var IUserManager */
41
+    private $userManager;
42
+    /** @var IConfig */
43
+    private $config;
44
+    /** @var IL10N */
45
+    protected $l10n;
46
+    /** @var ISession */
47
+    private $session;
48
+    /** @var IURLGenerator */
49
+    private $urlGenerator;
50 50
 
51
-	/**
52
-	 * @param string $appName
53
-	 * @param IRequest $request
54
-	 * @param IUserManager $userManager
55
-	 * @param IConfig $config
56
-	 * @param IURLGenerator $urlGenerator
57
-	 */
58
-	function __construct($appName, IRequest $request, IUserManager $userManager, 
59
-		IConfig $config, IL10N $l10n, ISession $session, IURLGenerator $urlGenerator) {
60
-		parent::__construct($appName, $request);
61
-		$this->userManager = $userManager;
62
-		$this->config = $config;
63
-		$this->l10n = $l10n;
64
-		$this->session = $session;
65
-		$this->urlGenerator = $urlGenerator;
66
-	}
51
+    /**
52
+     * @param string $appName
53
+     * @param IRequest $request
54
+     * @param IUserManager $userManager
55
+     * @param IConfig $config
56
+     * @param IURLGenerator $urlGenerator
57
+     */
58
+    function __construct($appName, IRequest $request, IUserManager $userManager, 
59
+        IConfig $config, IL10N $l10n, ISession $session, IURLGenerator $urlGenerator) {
60
+        parent::__construct($appName, $request);
61
+        $this->userManager = $userManager;
62
+        $this->config = $config;
63
+        $this->l10n = $l10n;
64
+        $this->session = $session;
65
+        $this->urlGenerator = $urlGenerator;
66
+    }
67 67
 
68
-	/**
69
-	 * @PublicPage
70
-	 * @NoCSRFRequired
71
-	 *
72
-	 * @return RedirectResponse
73
-	 */
74
-	public function cancel() {
75
-		return new RedirectResponse($this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm'));
76
-	}
68
+    /**
69
+     * @PublicPage
70
+     * @NoCSRFRequired
71
+     *
72
+     * @return RedirectResponse
73
+     */
74
+    public function cancel() {
75
+        return new RedirectResponse($this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm'));
76
+    }
77 77
 
78
-	/**
79
-	 * @PublicPage
80
-	 * @NoCSRFRequired
81
-	 * @UseSession
82
-	 *
83
-	 * @param string $user
84
-	 *
85
-	 * @return TemplateResponse|RedirectResponse
86
-	 */
87
-	public function showRenewPasswordForm($user) {
88
-		if($this->config->getUserValue($user, 'user_ldap', 'needsPasswordReset') !== 'true') {
89
-			return new RedirectResponse($this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm'));
90
-		}
91
-		$parameters = [];
92
-		$renewPasswordMessages = $this->session->get('renewPasswordMessages');
93
-		$errors = [];
94
-		$messages = [];
95
-		if (is_array($renewPasswordMessages)) {
96
-			list($errors, $messages) = $renewPasswordMessages;
97
-		}
98
-		$this->session->remove('renewPasswordMessages');
99
-		foreach ($errors as $value) {
100
-			$parameters[$value] = true;
101
-		}
78
+    /**
79
+     * @PublicPage
80
+     * @NoCSRFRequired
81
+     * @UseSession
82
+     *
83
+     * @param string $user
84
+     *
85
+     * @return TemplateResponse|RedirectResponse
86
+     */
87
+    public function showRenewPasswordForm($user) {
88
+        if($this->config->getUserValue($user, 'user_ldap', 'needsPasswordReset') !== 'true') {
89
+            return new RedirectResponse($this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm'));
90
+        }
91
+        $parameters = [];
92
+        $renewPasswordMessages = $this->session->get('renewPasswordMessages');
93
+        $errors = [];
94
+        $messages = [];
95
+        if (is_array($renewPasswordMessages)) {
96
+            list($errors, $messages) = $renewPasswordMessages;
97
+        }
98
+        $this->session->remove('renewPasswordMessages');
99
+        foreach ($errors as $value) {
100
+            $parameters[$value] = true;
101
+        }
102 102
 
103
-		$parameters['messages'] = $messages;
104
-		$parameters['user'] = $user;
103
+        $parameters['messages'] = $messages;
104
+        $parameters['user'] = $user;
105 105
 
106
-		$parameters['canResetPassword'] = true;
107
-		$parameters['resetPasswordLink'] = $this->config->getSystemValue('lost_password_link', '');
108
-		if (!$parameters['resetPasswordLink']) {
109
-			$userObj = $this->userManager->get($user);
110
-			if ($userObj instanceof IUser) {
111
-				$parameters['canResetPassword'] = $userObj->canChangePassword();
112
-			}
113
-		}
114
-		$parameters['cancelLink'] = $this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm');
106
+        $parameters['canResetPassword'] = true;
107
+        $parameters['resetPasswordLink'] = $this->config->getSystemValue('lost_password_link', '');
108
+        if (!$parameters['resetPasswordLink']) {
109
+            $userObj = $this->userManager->get($user);
110
+            if ($userObj instanceof IUser) {
111
+                $parameters['canResetPassword'] = $userObj->canChangePassword();
112
+            }
113
+        }
114
+        $parameters['cancelLink'] = $this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm');
115 115
 
116
-		return new TemplateResponse(
117
-			$this->appName, 'renewpassword', $parameters, 'guest'
118
-		);
119
-	}
116
+        return new TemplateResponse(
117
+            $this->appName, 'renewpassword', $parameters, 'guest'
118
+        );
119
+    }
120 120
 
121
-	/**
122
-	 * @PublicPage
123
-	 * @UseSession
124
-	 *
125
-	 * @param string $user
126
-	 * @param string $oldPassword
127
-	 * @param string $newPassword
128
-	 *
129
-	 * @return RedirectResponse
130
-	 */
131
-	public function tryRenewPassword($user, $oldPassword, $newPassword) {
132
-		if($this->config->getUserValue($user, 'user_ldap', 'needsPasswordReset') !== 'true') {
133
-			return new RedirectResponse($this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm'));
134
-		}
135
-		$args = !is_null($user) ? ['user' => $user] : [];
136
-		$loginResult = $this->userManager->checkPassword($user, $oldPassword);
137
-		if ($loginResult === false) {
138
-			$this->session->set('renewPasswordMessages', [
139
-				['invalidpassword'], []
140
-			]);
141
-			return new RedirectResponse($this->urlGenerator->linkToRoute('user_ldap.renewPassword.showRenewPasswordForm', $args));
142
-		}
121
+    /**
122
+     * @PublicPage
123
+     * @UseSession
124
+     *
125
+     * @param string $user
126
+     * @param string $oldPassword
127
+     * @param string $newPassword
128
+     *
129
+     * @return RedirectResponse
130
+     */
131
+    public function tryRenewPassword($user, $oldPassword, $newPassword) {
132
+        if($this->config->getUserValue($user, 'user_ldap', 'needsPasswordReset') !== 'true') {
133
+            return new RedirectResponse($this->urlGenerator->linkToRouteAbsolute('core.login.showLoginForm'));
134
+        }
135
+        $args = !is_null($user) ? ['user' => $user] : [];
136
+        $loginResult = $this->userManager->checkPassword($user, $oldPassword);
137
+        if ($loginResult === false) {
138
+            $this->session->set('renewPasswordMessages', [
139
+                ['invalidpassword'], []
140
+            ]);
141
+            return new RedirectResponse($this->urlGenerator->linkToRoute('user_ldap.renewPassword.showRenewPasswordForm', $args));
142
+        }
143 143
 		
144
-		try {
145
-			if (!is_null($newPassword) && \OC_User::setPassword($user, $newPassword)) {
146
-				$this->session->set('loginMessages', [
147
-					[], [$this->l10n->t("Please login with the new password")]
148
-				]);
149
-				$this->config->setUserValue($user, 'user_ldap', 'needsPasswordReset', 'false');
150
-				return new RedirectResponse($this->urlGenerator->linkToRoute('core.login.showLoginForm', $args));
151
-			} else {
152
-				$this->session->set('renewPasswordMessages', [
153
-					['internalexception'], []
154
-				]);
155
-			}
156
-		} catch (HintException $e) {
157
-			$this->session->set('renewPasswordMessages', [
158
-				[], [$e->getHint()]
159
-			]);
160
-		}
144
+        try {
145
+            if (!is_null($newPassword) && \OC_User::setPassword($user, $newPassword)) {
146
+                $this->session->set('loginMessages', [
147
+                    [], [$this->l10n->t("Please login with the new password")]
148
+                ]);
149
+                $this->config->setUserValue($user, 'user_ldap', 'needsPasswordReset', 'false');
150
+                return new RedirectResponse($this->urlGenerator->linkToRoute('core.login.showLoginForm', $args));
151
+            } else {
152
+                $this->session->set('renewPasswordMessages', [
153
+                    ['internalexception'], []
154
+                ]);
155
+            }
156
+        } catch (HintException $e) {
157
+            $this->session->set('renewPasswordMessages', [
158
+                [], [$e->getHint()]
159
+            ]);
160
+        }
161 161
 
162
-		return new RedirectResponse($this->urlGenerator->linkToRoute('user_ldap.renewPassword.showRenewPasswordForm', $args));
163
-	}
162
+        return new RedirectResponse($this->urlGenerator->linkToRoute('user_ldap.renewPassword.showRenewPasswordForm', $args));
163
+    }
164 164
 
165
-	/**
166
-	 * @PublicPage
167
-	 * @NoCSRFRequired
168
-	 * @UseSession
169
-	 *
170
-	 * @return RedirectResponse
171
-	 */
172
-	public function showLoginFormInvalidPassword($user) {
173
-		$args = !is_null($user) ? ['user' => $user] : [];
174
-		$this->session->set('loginMessages', [
175
-			['invalidpassword'], []
176
-		]);
177
-		return new RedirectResponse($this->urlGenerator->linkToRoute('core.login.showLoginForm', $args));
178
-	}
165
+    /**
166
+     * @PublicPage
167
+     * @NoCSRFRequired
168
+     * @UseSession
169
+     *
170
+     * @return RedirectResponse
171
+     */
172
+    public function showLoginFormInvalidPassword($user) {
173
+        $args = !is_null($user) ? ['user' => $user] : [];
174
+        $this->session->set('loginMessages', [
175
+            ['invalidpassword'], []
176
+        ]);
177
+        return new RedirectResponse($this->urlGenerator->linkToRoute('core.login.showLoginForm', $args));
178
+    }
179 179
 
180 180
 }
Please login to merge, or discard this patch.
lib/public/AppFramework/Http/StreamResponse.php 3 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -37,7 +37,7 @@
 block discarded – undo
37 37
 	private $filePath;
38 38
 
39 39
 	/**
40
-	 * @param string|resource $filePath the path to the file or a file handle which should be streamed
40
+	 * @param string $filePath the path to the file or a file handle which should be streamed
41 41
 	 * @since 8.1.0
42 42
 	 */
43 43
 	public function __construct ($filePath) {
Please login to merge, or discard this patch.
Indentation   +25 added lines, -25 removed lines patch added patch discarded remove patch
@@ -33,33 +33,33 @@
 block discarded – undo
33 33
  * @since 8.1.0
34 34
  */
35 35
 class StreamResponse extends Response implements ICallbackResponse {
36
-	/** @var string */
37
-	private $filePath;
36
+    /** @var string */
37
+    private $filePath;
38 38
 
39
-	/**
40
-	 * @param string|resource $filePath the path to the file or a file handle which should be streamed
41
-	 * @since 8.1.0
42
-	 */
43
-	public function __construct ($filePath) {
44
-		$this->filePath = $filePath;
45
-	}
39
+    /**
40
+     * @param string|resource $filePath the path to the file or a file handle which should be streamed
41
+     * @since 8.1.0
42
+     */
43
+    public function __construct ($filePath) {
44
+        $this->filePath = $filePath;
45
+    }
46 46
 
47 47
 
48
-	/**
49
-	 * Streams the file using readfile
50
-	 *
51
-	 * @param IOutput $output a small wrapper that handles output
52
-	 * @since 8.1.0
53
-	 */
54
-	public function callback (IOutput $output) {
55
-		// handle caching
56
-		if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) {
57
-			if (!(is_resource($this->filePath) || file_exists($this->filePath))) {
58
-				$output->setHttpResponseCode(Http::STATUS_NOT_FOUND);
59
-			} elseif ($output->setReadfile($this->filePath) === false) {
60
-				$output->setHttpResponseCode(Http::STATUS_BAD_REQUEST);
61
-			}
62
-		}
63
-	}
48
+    /**
49
+     * Streams the file using readfile
50
+     *
51
+     * @param IOutput $output a small wrapper that handles output
52
+     * @since 8.1.0
53
+     */
54
+    public function callback (IOutput $output) {
55
+        // handle caching
56
+        if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) {
57
+            if (!(is_resource($this->filePath) || file_exists($this->filePath))) {
58
+                $output->setHttpResponseCode(Http::STATUS_NOT_FOUND);
59
+            } elseif ($output->setReadfile($this->filePath) === false) {
60
+                $output->setHttpResponseCode(Http::STATUS_BAD_REQUEST);
61
+            }
62
+        }
63
+    }
64 64
 
65 65
 }
Please login to merge, or discard this patch.
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -40,7 +40,7 @@  discard block
 block discarded – undo
40 40
 	 * @param string|resource $filePath the path to the file or a file handle which should be streamed
41 41
 	 * @since 8.1.0
42 42
 	 */
43
-	public function __construct ($filePath) {
43
+	public function __construct($filePath) {
44 44
 		$this->filePath = $filePath;
45 45
 	}
46 46
 
@@ -51,7 +51,7 @@  discard block
 block discarded – undo
51 51
 	 * @param IOutput $output a small wrapper that handles output
52 52
 	 * @since 8.1.0
53 53
 	 */
54
-	public function callback (IOutput $output) {
54
+	public function callback(IOutput $output) {
55 55
 		// handle caching
56 56
 		if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) {
57 57
 			if (!(is_resource($this->filePath) || file_exists($this->filePath))) {
Please login to merge, or discard this patch.
apps/dav/lib/Connector/Sabre/DavAclPlugin.php 3 patches
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -47,6 +47,9 @@
 block discarded – undo
47 47
 		$this->allowUnauthenticatedAccess = false;
48 48
 	}
49 49
 
50
+	/**
51
+	 * @param string $privileges
52
+	 */
50 53
 	function checkPrivileges($uri, $privileges, $recursion = self::R_PARENT, $throwExceptions = true) {
51 54
 		$access = parent::checkPrivileges($uri, $privileges, $recursion, false);
52 55
 		if($access === false && $throwExceptions) {
Please login to merge, or discard this patch.
Indentation   +41 added lines, -41 removed lines patch added patch discarded remove patch
@@ -38,50 +38,50 @@
 block discarded – undo
38 38
  * @package OCA\DAV\Connector\Sabre
39 39
  */
40 40
 class DavAclPlugin extends \Sabre\DAVACL\Plugin {
41
-	public function __construct() {
42
-		$this->hideNodesFromListings = true;
43
-		$this->allowUnauthenticatedAccess = false;
44
-	}
41
+    public function __construct() {
42
+        $this->hideNodesFromListings = true;
43
+        $this->allowUnauthenticatedAccess = false;
44
+    }
45 45
 
46
-	function checkPrivileges($uri, $privileges, $recursion = self::R_PARENT, $throwExceptions = true) {
47
-		$access = parent::checkPrivileges($uri, $privileges, $recursion, false);
48
-		if($access === false && $throwExceptions) {
49
-			/** @var INode $node */
50
-			$node = $this->server->tree->getNodeForPath($uri);
46
+    function checkPrivileges($uri, $privileges, $recursion = self::R_PARENT, $throwExceptions = true) {
47
+        $access = parent::checkPrivileges($uri, $privileges, $recursion, false);
48
+        if($access === false && $throwExceptions) {
49
+            /** @var INode $node */
50
+            $node = $this->server->tree->getNodeForPath($uri);
51 51
 
52
-			switch(get_class($node)) {
53
-				case AddressBook::class:
54
-					$type = 'Addressbook';
55
-					break;
56
-				default:
57
-					$type = 'Node';
58
-					break;
59
-			}
60
-			throw new NotFound(
61
-				sprintf(
62
-					"%s with name '%s' could not be found",
63
-					$type,
64
-					$node->getName()
65
-				)
66
-			);
67
-		}
52
+            switch(get_class($node)) {
53
+                case AddressBook::class:
54
+                    $type = 'Addressbook';
55
+                    break;
56
+                default:
57
+                    $type = 'Node';
58
+                    break;
59
+            }
60
+            throw new NotFound(
61
+                sprintf(
62
+                    "%s with name '%s' could not be found",
63
+                    $type,
64
+                    $node->getName()
65
+                )
66
+            );
67
+        }
68 68
 
69
-		return $access;
70
-	}
69
+        return $access;
70
+    }
71 71
 
72
-	public function propFind(PropFind $propFind, INode $node) {
73
-		// If the node is neither readable nor writable then fail unless its of
74
-		// the standard user-principal
75
-		if(!($node instanceof User)) {
76
-			$path = $propFind->getPath();
77
-			$readPermissions = $this->checkPrivileges($path, '{DAV:}read', self::R_PARENT, false);
78
-			$writePermissions = $this->checkPrivileges($path, '{DAV:}write', self::R_PARENT, false);
79
-			if ($readPermissions === false && $writePermissions === false) {
80
-				$this->checkPrivileges($path, '{DAV:}read', self::R_PARENT, true);
81
-				$this->checkPrivileges($path, '{DAV:}write', self::R_PARENT, true);
82
-			}
83
-		}
72
+    public function propFind(PropFind $propFind, INode $node) {
73
+        // If the node is neither readable nor writable then fail unless its of
74
+        // the standard user-principal
75
+        if(!($node instanceof User)) {
76
+            $path = $propFind->getPath();
77
+            $readPermissions = $this->checkPrivileges($path, '{DAV:}read', self::R_PARENT, false);
78
+            $writePermissions = $this->checkPrivileges($path, '{DAV:}write', self::R_PARENT, false);
79
+            if ($readPermissions === false && $writePermissions === false) {
80
+                $this->checkPrivileges($path, '{DAV:}read', self::R_PARENT, true);
81
+                $this->checkPrivileges($path, '{DAV:}write', self::R_PARENT, true);
82
+            }
83
+        }
84 84
 
85
-		return parent::propFind($propFind, $node);
86
-	}
85
+        return parent::propFind($propFind, $node);
86
+    }
87 87
 }
Please login to merge, or discard this patch.
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -45,11 +45,11 @@  discard block
 block discarded – undo
45 45
 
46 46
 	function checkPrivileges($uri, $privileges, $recursion = self::R_PARENT, $throwExceptions = true) {
47 47
 		$access = parent::checkPrivileges($uri, $privileges, $recursion, false);
48
-		if($access === false && $throwExceptions) {
48
+		if ($access === false && $throwExceptions) {
49 49
 			/** @var INode $node */
50 50
 			$node = $this->server->tree->getNodeForPath($uri);
51 51
 
52
-			switch(get_class($node)) {
52
+			switch (get_class($node)) {
53 53
 				case AddressBook::class:
54 54
 					$type = 'Addressbook';
55 55
 					break;
@@ -72,7 +72,7 @@  discard block
 block discarded – undo
72 72
 	public function propFind(PropFind $propFind, INode $node) {
73 73
 		// If the node is neither readable nor writable then fail unless its of
74 74
 		// the standard user-principal
75
-		if(!($node instanceof User)) {
75
+		if (!($node instanceof User)) {
76 76
 			$path = $propFind->getPath();
77 77
 			$readPermissions = $this->checkPrivileges($path, '{DAV:}read', self::R_PARENT, false);
78 78
 			$writePermissions = $this->checkPrivileges($path, '{DAV:}write', self::R_PARENT, false);
Please login to merge, or discard this patch.