nextcloud / server

apps/provisioning_api/lib/Controller/GroupsController.php

Indentation +220 added lines, -220 removed lines

@@ -44,247 +44,247 @@
 
 class GroupsController extends AUserData {
 
-	/** @var ILogger */
-	private $logger;
+    /** @var ILogger */
+    private $logger;
 
-	/**
-	 * @param string $appName
-	 * @param IRequest $request
-	 * @param IUserManager $userManager
-	 * @param IConfig $config
-	 * @param IGroupManager $groupManager
-	 * @param IUserSession $userSession
-	 * @param AccountManager $accountManager
-	 * @param ILogger $logger
-	 * @param UsersController $userController
-	 */
-	public function __construct(string $appName,
-								IRequest $request,
-								IUserManager $userManager,
-								IConfig $config,
-								IGroupManager $groupManager,
-								IUserSession $userSession,
-								AccountManager $accountManager,
-								ILogger $logger) {
-		parent::__construct($appName,
-			$request,
-			$userManager,
-			$config,
-			$groupManager,
-			$userSession,
-			$accountManager);
+    /**
+     * @param string $appName
+     * @param IRequest $request
+     * @param IUserManager $userManager
+     * @param IConfig $config
+     * @param IGroupManager $groupManager
+     * @param IUserSession $userSession
+     * @param AccountManager $accountManager
+     * @param ILogger $logger
+     * @param UsersController $userController
+     */
+    public function __construct(string $appName,
+                                IRequest $request,
+                                IUserManager $userManager,
+                                IConfig $config,
+                                IGroupManager $groupManager,
+                                IUserSession $userSession,
+                                AccountManager $accountManager,
+                                ILogger $logger) {
+        parent::__construct($appName,
+            $request,
+            $userManager,
+            $config,
+            $groupManager,
+            $userSession,
+            $accountManager);
 
-		$this->logger = $logger;
-	}
+        $this->logger = $logger;
+    }
 
-	/**
-	 * returns a list of groups
-	 *
-	 * @NoAdminRequired
-	 *
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return DataResponse
-	 */
-	public function getGroups(string $search = '', int $limit = null, int $offset = 0): DataResponse {
-		$groups = $this->groupManager->search($search, $limit, $offset);
-		$groups = array_map(function($group) {
-			/** @var IGroup $group */
-			return $group->getGID();
-		}, $groups);
+    /**
+     * returns a list of groups
+     *
+     * @NoAdminRequired
+     *
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return DataResponse
+     */
+    public function getGroups(string $search = '', int $limit = null, int $offset = 0): DataResponse {
+        $groups = $this->groupManager->search($search, $limit, $offset);
+        $groups = array_map(function($group) {
+            /** @var IGroup $group */
+            return $group->getGID();
+        }, $groups);
 
-		return new DataResponse(['groups' => $groups]);
-	}
+        return new DataResponse(['groups' => $groups]);
+    }
 
-	/**
-	 * returns a list of groups details with ids and displaynames
-	 *
-	 * @NoAdminRequired
-	 *
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return DataResponse
-	 */
-	public function getGroupsDetails(string $search = '', int $limit = null, int $offset = 0): DataResponse {
-		$groups = $this->groupManager->search($search, $limit, $offset);
-		$groups = array_map(function($group) {
-			/** @var IGroup $group */
-			return [
-				'id' => $group->getGID(),
-				'displayname' => $group->getDisplayName(),
-				'usercount' => $group->count(),
-				'disabled' => $group->countDisabled(),
-				'canAdd' => $group->canAddUser(),
-				'canRemove' => $group->canRemoveUser(),
-			];
-		}, $groups);
+    /**
+     * returns a list of groups details with ids and displaynames
+     *
+     * @NoAdminRequired
+     *
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return DataResponse
+     */
+    public function getGroupsDetails(string $search = '', int $limit = null, int $offset = 0): DataResponse {
+        $groups = $this->groupManager->search($search, $limit, $offset);
+        $groups = array_map(function($group) {
+            /** @var IGroup $group */
+            return [
+                'id' => $group->getGID(),
+                'displayname' => $group->getDisplayName(),
+                'usercount' => $group->count(),
+                'disabled' => $group->countDisabled(),
+                'canAdd' => $group->canAddUser(),
+                'canRemove' => $group->canRemoveUser(),
+            ];
+        }, $groups);
 
-		return new DataResponse(['groups' => $groups]);
-	}
+        return new DataResponse(['groups' => $groups]);
+    }
 
-	/**
-	 * @NoAdminRequired
-	 *
-	 * @param string $groupId
-	 * @return DataResponse
-	 * @throws OCSException	
-	 *
-	 * @deprecated 14 Use getGroupUsers
-	 */
-	public function getGroup(string $groupId): DataResponse {
-		return $this->getGroupUsers($groupId);
-	}
+    /**
+     * @NoAdminRequired
+     *
+     * @param string $groupId
+     * @return DataResponse
+     * @throws OCSException	
+     *
+     * @deprecated 14 Use getGroupUsers
+     */
+    public function getGroup(string $groupId): DataResponse {
+        return $this->getGroupUsers($groupId);
+    }
 
-	/**
-	 * returns an array of users in the specified group
-	 *
-	 * @NoAdminRequired
-	 *
-	 * @param string $groupId
-	 * @return DataResponse
-	 * @throws OCSException
-	 */
-	public function getGroupUsers(string $groupId): DataResponse {
-		$user = $this->userSession->getUser();
-		$isSubadminOfGroup = false;
+    /**
+     * returns an array of users in the specified group
+     *
+     * @NoAdminRequired
+     *
+     * @param string $groupId
+     * @return DataResponse
+     * @throws OCSException
+     */
+    public function getGroupUsers(string $groupId): DataResponse {
+        $user = $this->userSession->getUser();
+        $isSubadminOfGroup = false;
 
-		// Check the group exists
-		$group = $this->groupManager->get($groupId);
-		if ($group !== null) {
-			$isSubadminOfGroup =$this->groupManager->getSubAdmin()->isSubAdminOfGroup($user, $group);
-		} else {
-			throw new OCSNotFoundException('The requested group could not be found');
-		}
+        // Check the group exists
+        $group = $this->groupManager->get($groupId);
+        if ($group !== null) {
+            $isSubadminOfGroup =$this->groupManager->getSubAdmin()->isSubAdminOfGroup($user, $group);
+        } else {
+            throw new OCSNotFoundException('The requested group could not be found');
+        }
 
-		// Check subadmin has access to this group
-		if($this->groupManager->isAdmin($user->getUID())
-		   || $isSubadminOfGroup) {
-			$users = $this->groupManager->get($groupId)->getUsers();
-			$users =  array_map(function($user) {
-				/** @var IUser $user */
-				return $user->getUID();
-			}, $users);
-			$users = array_values($users);
-			return new DataResponse(['users' => $users]);
-		}
+        // Check subadmin has access to this group
+        if($this->groupManager->isAdmin($user->getUID())
+           || $isSubadminOfGroup) {
+            $users = $this->groupManager->get($groupId)->getUsers();
+            $users =  array_map(function($user) {
+                /** @var IUser $user */
+                return $user->getUID();
+            }, $users);
+            $users = array_values($users);
+            return new DataResponse(['users' => $users]);
+        }
 
-		throw new OCSForbiddenException();
-	}
+        throw new OCSForbiddenException();
+    }
 
-	/**
-	 * returns an array of users details in the specified group
-	 *
-	 * @NoAdminRequired
-	 *
-	 * @param string $groupId
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return DataResponse
-	 * @throws OCSException
-	 */
-	public function getGroupUsersDetails(string $groupId, string $search = '', int $limit = null, int $offset = 0): DataResponse {
-		$user = $this->userSession->getUser();
-		$isSubadminOfGroup = false;
+    /**
+     * returns an array of users details in the specified group
+     *
+     * @NoAdminRequired
+     *
+     * @param string $groupId
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return DataResponse
+     * @throws OCSException
+     */
+    public function getGroupUsersDetails(string $groupId, string $search = '', int $limit = null, int $offset = 0): DataResponse {
+        $user = $this->userSession->getUser();
+        $isSubadminOfGroup = false;
 
-		// Check the group exists
-		$group = $this->groupManager->get($groupId);
-		if ($group !== null) {
-			$isSubadminOfGroup =$this->groupManager->getSubAdmin()->isSubAdminOfGroup($user, $group);
-		} else {
-			throw new OCSException('The requested group could not be found', \OCP\API::RESPOND_NOT_FOUND);
-		}
+        // Check the group exists
+        $group = $this->groupManager->get($groupId);
+        if ($group !== null) {
+            $isSubadminOfGroup =$this->groupManager->getSubAdmin()->isSubAdminOfGroup($user, $group);
+        } else {
+            throw new OCSException('The requested group could not be found', \OCP\API::RESPOND_NOT_FOUND);
+        }
 
-		// Check subadmin has access to this group
-		if($this->groupManager->isAdmin($user->getUID())
-		   || $isSubadminOfGroup) {
-			$users = $this->groupManager->get($groupId)->searchUsers($search, $limit, $offset);
+        // Check subadmin has access to this group
+        if($this->groupManager->isAdmin($user->getUID())
+           || $isSubadminOfGroup) {
+            $users = $this->groupManager->get($groupId)->searchUsers($search, $limit, $offset);
 
-			// Extract required number
-			$users = array_keys($users);
-			$usersDetails = [];
-			foreach ($users as $userId) {
-				$userData = $this->getUserData($userId);
-				// Do not insert empty entry
-				if(!empty($userData)) {
-					$usersDetails[$userId] = $userData;
-				} else {
-					// Logged user does not have permissions to see this user
-					// only showing its id
-					$usersDetails[$userId] = ['id' => $userId];
-				}
-			}
-			return new DataResponse(['users' => $usersDetails]);
-		}
+            // Extract required number
+            $users = array_keys($users);
+            $usersDetails = [];
+            foreach ($users as $userId) {
+                $userData = $this->getUserData($userId);
+                // Do not insert empty entry
+                if(!empty($userData)) {
+                    $usersDetails[$userId] = $userData;
+                } else {
+                    // Logged user does not have permissions to see this user
+                    // only showing its id
+                    $usersDetails[$userId] = ['id' => $userId];
+                }
+            }
+            return new DataResponse(['users' => $usersDetails]);
+        }
 
-		throw new OCSException('User does not have access to specified group', \OCP\API::RESPOND_UNAUTHORISED);
-	}
+        throw new OCSException('User does not have access to specified group', \OCP\API::RESPOND_UNAUTHORISED);
+    }
 
-	/**
-	 * creates a new group
-	 *
-	 * @PasswordConfirmationRequired
-	 *
-	 * @param string $groupid
-	 * @return DataResponse
-	 * @throws OCSException
-	 */
-	public function addGroup(string $groupid): DataResponse {
-		// Validate name
-		if(empty($groupid)) {
-			$this->logger->error('Group name not supplied', ['app' => 'provisioning_api']);
-			throw new OCSException('Invalid group name', 101);
-		}
-		// Check if it exists
-		if($this->groupManager->groupExists($groupid)){
-			throw new OCSException('group exists', 102);
-		}
-		$this->groupManager->createGroup($groupid);
-		return new DataResponse();
-	}
+    /**
+     * creates a new group
+     *
+     * @PasswordConfirmationRequired
+     *
+     * @param string $groupid
+     * @return DataResponse
+     * @throws OCSException
+     */
+    public function addGroup(string $groupid): DataResponse {
+        // Validate name
+        if(empty($groupid)) {
+            $this->logger->error('Group name not supplied', ['app' => 'provisioning_api']);
+            throw new OCSException('Invalid group name', 101);
+        }
+        // Check if it exists
+        if($this->groupManager->groupExists($groupid)){
+            throw new OCSException('group exists', 102);
+        }
+        $this->groupManager->createGroup($groupid);
+        return new DataResponse();
+    }
 
-	/**
-	 * @PasswordConfirmationRequired
-	 *
-	 * @param string $groupId
-	 * @return DataResponse
-	 * @throws OCSException
-	 */
-	public function deleteGroup(string $groupId): DataResponse {
-		// Check it exists
-		if(!$this->groupManager->groupExists($groupId)){
-			throw new OCSException('', 101);
-		} else if($groupId === 'admin' || !$this->groupManager->get($groupId)->delete()){
-			// Cannot delete admin group
-			throw new OCSException('', 102);
-		}
+    /**
+     * @PasswordConfirmationRequired
+     *
+     * @param string $groupId
+     * @return DataResponse
+     * @throws OCSException
+     */
+    public function deleteGroup(string $groupId): DataResponse {
+        // Check it exists
+        if(!$this->groupManager->groupExists($groupId)){
+            throw new OCSException('', 101);
+        } else if($groupId === 'admin' || !$this->groupManager->get($groupId)->delete()){
+            // Cannot delete admin group
+            throw new OCSException('', 102);
+        }
 
-		return new DataResponse();
-	}
+        return new DataResponse();
+    }
 
-	/**
-	 * @param string $groupId
-	 * @return DataResponse
-	 * @throws OCSException
-	 */
-	public function getSubAdminsOfGroup(string $groupId): DataResponse {
-		// Check group exists
-		$targetGroup = $this->groupManager->get($groupId);
-		if($targetGroup === null) {
-			throw new OCSException('Group does not exist', 101);
-		}
+    /**
+     * @param string $groupId
+     * @return DataResponse
+     * @throws OCSException
+     */
+    public function getSubAdminsOfGroup(string $groupId): DataResponse {
+        // Check group exists
+        $targetGroup = $this->groupManager->get($groupId);
+        if($targetGroup === null) {
+            throw new OCSException('Group does not exist', 101);
+        }
 
-		/** @var IUser[] $subadmins */
-		$subadmins = $this->groupManager->getSubAdmin()->getGroupsSubAdmins($targetGroup);
-		// New class returns IUser[] so convert back
-		$uids = [];
-		foreach ($subadmins as $user) {
-			$uids[] = $user->getUID();
-		}
+        /** @var IUser[] $subadmins */
+        $subadmins = $this->groupManager->getSubAdmin()->getGroupsSubAdmins($targetGroup);
+        // New class returns IUser[] so convert back
+        $uids = [];
+        foreach ($subadmins as $user) {
+            $uids[] = $user->getUID();
+        }
 
-		return new DataResponse($uids);
-	}
+        return new DataResponse($uids);
+    }
 
 }

Spacing +11 added lines, -11 removed lines

@@ -153,16 +153,16 @@ 
 		// Check the group exists
 		$group = $this->groupManager->get($groupId);
 		if ($group !== null) {
-			$isSubadminOfGroup =$this->groupManager->getSubAdmin()->isSubAdminOfGroup($user, $group);
+			$isSubadminOfGroup = $this->groupManager->getSubAdmin()->isSubAdminOfGroup($user, $group);
 		} else {
 			throw new OCSNotFoundException('The requested group could not be found');
 		}
 
 		// Check subadmin has access to this group
-		if($this->groupManager->isAdmin($user->getUID())
+		if ($this->groupManager->isAdmin($user->getUID())
 		   || $isSubadminOfGroup) {
 			$users = $this->groupManager->get($groupId)->getUsers();
-			$users =  array_map(function($user) {
+			$users = array_map(function($user) {
 				/** @var IUser $user */
 				return $user->getUID();
 			}, $users);
@@ -192,13 +192,13 @@ 
 		// Check the group exists
 		$group = $this->groupManager->get($groupId);
 		if ($group !== null) {
-			$isSubadminOfGroup =$this->groupManager->getSubAdmin()->isSubAdminOfGroup($user, $group);
+			$isSubadminOfGroup = $this->groupManager->getSubAdmin()->isSubAdminOfGroup($user, $group);
 		} else {
 			throw new OCSException('The requested group could not be found', \OCP\API::RESPOND_NOT_FOUND);
 		}
 
 		// Check subadmin has access to this group
-		if($this->groupManager->isAdmin($user->getUID())
+		if ($this->groupManager->isAdmin($user->getUID())
 		   || $isSubadminOfGroup) {
 			$users = $this->groupManager->get($groupId)->searchUsers($search, $limit, $offset);
 
@@ -208,7 +208,7 @@ 
 			foreach ($users as $userId) {
 				$userData = $this->getUserData($userId);
 				// Do not insert empty entry
-				if(!empty($userData)) {
+				if (!empty($userData)) {
 					$usersDetails[$userId] = $userData;
 				} else {
 					// Logged user does not have permissions to see this user
@@ -233,12 +233,12 @@ 
 	 */
 	public function addGroup(string $groupid): DataResponse {
 		// Validate name
-		if(empty($groupid)) {
+		if (empty($groupid)) {
 			$this->logger->error('Group name not supplied', ['app' => 'provisioning_api']);
 			throw new OCSException('Invalid group name', 101);
 		}
 		// Check if it exists
-		if($this->groupManager->groupExists($groupid)){
+		if ($this->groupManager->groupExists($groupid)) {
 			throw new OCSException('group exists', 102);
 		}
 		$this->groupManager->createGroup($groupid);
@@ -254,9 +254,9 @@ 
 	 */
 	public function deleteGroup(string $groupId): DataResponse {
 		// Check it exists
-		if(!$this->groupManager->groupExists($groupId)){
+		if (!$this->groupManager->groupExists($groupId)) {
 			throw new OCSException('', 101);
-		} else if($groupId === 'admin' || !$this->groupManager->get($groupId)->delete()){
+		} else if ($groupId === 'admin' || !$this->groupManager->get($groupId)->delete()) {
 			// Cannot delete admin group
 			throw new OCSException('', 102);
 		}
@@ -272,7 +272,7 @@ 
 	public function getSubAdminsOfGroup(string $groupId): DataResponse {
 		// Check group exists
 		$targetGroup = $this->groupManager->get($groupId);
-		if($targetGroup === null) {
+		if ($targetGroup === null) {
 			throw new OCSException('Group does not exist', 101);
 		}