nextcloud / server

apps/provisioning_api/lib/Controller/GroupsController.php

Indentation +185 added lines, -185 removed lines

@@ -40,190 +40,190 @@
 
 class GroupsController extends OCSController {
 
-	/** @var IGroupManager */
-	private $groupManager;
-
-	/** @var IUserSession */
-	private $userSession;
-
-	/** @var ILogger */
-	private $logger;
-
-	/**
-	 * @param string $appName
-	 * @param IRequest $request
-	 * @param IGroupManager $groupManager
-	 * @param IUserSession $userSession
-	 * @param ILogger $logger
-	 */
-	public function __construct(
-			string $appName,
-			IRequest $request,
-			IGroupManager $groupManager,
-			IUserSession $userSession,
-			ILogger $logger) {
-		parent::__construct($appName, $request);
-
-		$this->groupManager = $groupManager;
-		$this->userSession = $userSession;
-		$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 = '', $limit = null, $offset = null): DataResponse {
-		if ($limit !== null) {
-			$limit = (int)$limit;
-		}
-		if ($offset !== null) {
-			$offset = (int)$offset;
-		}
-
-		$groups = $this->groupManager->search($search, $limit, $offset);
-		$groups = array_map(function($group) {
-			/** @var IGroup $group */
-			return $group->getGID();
-		}, $groups);
-
-		return new DataResponse(['groups' => $groups]);
-	}
-
-	/**
-	 * returns a list of groups
-	 *
-	 * @NoAdminRequired
-	 *
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return DataResponse
-	 */
-	public function getGroupsDetails(string $search = '', $limit = null, $offset = null): DataResponse {
-		if ($limit !== null) {
-			$limit = (int)$limit;
-		}
-		if ($offset !== null) {
-			$offset = (int)$offset;
-		}
-
-		$groups = $this->groupManager->search($search, $limit, $offset);
-		$groups = array_map(function($group) {
-			/** @var IGroup $group */
-			return ['id' => $group->getGID(), 'displayname' => $group->getDisplayName()];
-		}, $groups);
-
-		return new DataResponse(['groups' => $groups]);
-	}
-
-	/**
-	 * returns an array of users in the group specified
-	 *
-	 * @NoAdminRequired
-	 *
-	 * @param string $groupId
-	 * @return DataResponse
-	 * @throws OCSException
-	 */
-	public function getGroup(string $groupId): DataResponse {
-		$user = $this->userSession->getUser();
-
-		// Check the group exists
-		if(!$this->groupManager->groupExists($groupId)) {
-			throw new OCSException('The requested group could not be found', \OCP\API::RESPOND_NOT_FOUND);
-		}
-
-		$isSubadminOfGroup = false;
-		$group = $this->groupManager->get($groupId);
-		if ($group !== null) {
-			$isSubadminOfGroup =$this->groupManager->getSubAdmin()->isSubAdminofGroup($user, $group);
-		}
-
-		// 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 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('', 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);
-		}
-
-		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);
-		}
-
-		/** @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);
-	}
+    /** @var IGroupManager */
+    private $groupManager;
+
+    /** @var IUserSession */
+    private $userSession;
+
+    /** @var ILogger */
+    private $logger;
+
+    /**
+     * @param string $appName
+     * @param IRequest $request
+     * @param IGroupManager $groupManager
+     * @param IUserSession $userSession
+     * @param ILogger $logger
+     */
+    public function __construct(
+            string $appName,
+            IRequest $request,
+            IGroupManager $groupManager,
+            IUserSession $userSession,
+            ILogger $logger) {
+        parent::__construct($appName, $request);
+
+        $this->groupManager = $groupManager;
+        $this->userSession = $userSession;
+        $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 = '', $limit = null, $offset = null): DataResponse {
+        if ($limit !== null) {
+            $limit = (int)$limit;
+        }
+        if ($offset !== null) {
+            $offset = (int)$offset;
+        }
+
+        $groups = $this->groupManager->search($search, $limit, $offset);
+        $groups = array_map(function($group) {
+            /** @var IGroup $group */
+            return $group->getGID();
+        }, $groups);
+
+        return new DataResponse(['groups' => $groups]);
+    }
+
+    /**
+     * returns a list of groups
+     *
+     * @NoAdminRequired
+     *
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return DataResponse
+     */
+    public function getGroupsDetails(string $search = '', $limit = null, $offset = null): DataResponse {
+        if ($limit !== null) {
+            $limit = (int)$limit;
+        }
+        if ($offset !== null) {
+            $offset = (int)$offset;
+        }
+
+        $groups = $this->groupManager->search($search, $limit, $offset);
+        $groups = array_map(function($group) {
+            /** @var IGroup $group */
+            return ['id' => $group->getGID(), 'displayname' => $group->getDisplayName()];
+        }, $groups);
+
+        return new DataResponse(['groups' => $groups]);
+    }
+
+    /**
+     * returns an array of users in the group specified
+     *
+     * @NoAdminRequired
+     *
+     * @param string $groupId
+     * @return DataResponse
+     * @throws OCSException
+     */
+    public function getGroup(string $groupId): DataResponse {
+        $user = $this->userSession->getUser();
+
+        // Check the group exists
+        if(!$this->groupManager->groupExists($groupId)) {
+            throw new OCSException('The requested group could not be found', \OCP\API::RESPOND_NOT_FOUND);
+        }
+
+        $isSubadminOfGroup = false;
+        $group = $this->groupManager->get($groupId);
+        if ($group !== null) {
+            $isSubadminOfGroup =$this->groupManager->getSubAdmin()->isSubAdminofGroup($user, $group);
+        }
+
+        // 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 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('', 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);
+        }
+
+        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);
+        }
+
+        /** @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);
+    }
 
 }

Spacing +14 added lines, -14 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 /**
  * @copyright Copyright (c) 2016, ownCloud, Inc.
  *
@@ -81,10 +81,10 @@ 
 	 */
 	public function getGroups(string $search = '', $limit = null, $offset = null): DataResponse {
 		if ($limit !== null) {
-			$limit = (int)$limit;
+			$limit = (int) $limit;
 		}
 		if ($offset !== null) {
-			$offset = (int)$offset;
+			$offset = (int) $offset;
 		}
 
 		$groups = $this->groupManager->search($search, $limit, $offset);
@@ -108,10 +108,10 @@ 
 	 */
 	public function getGroupsDetails(string $search = '', $limit = null, $offset = null): DataResponse {
 		if ($limit !== null) {
-			$limit = (int)$limit;
+			$limit = (int) $limit;
 		}
 		if ($offset !== null) {
-			$offset = (int)$offset;
+			$offset = (int) $offset;
 		}
 
 		$groups = $this->groupManager->search($search, $limit, $offset);
@@ -136,21 +136,21 @@ 
 		$user = $this->userSession->getUser();
 
 		// Check the group exists
-		if(!$this->groupManager->groupExists($groupId)) {
+		if (!$this->groupManager->groupExists($groupId)) {
 			throw new OCSException('The requested group could not be found', \OCP\API::RESPOND_NOT_FOUND);
 		}
 
 		$isSubadminOfGroup = false;
 		$group = $this->groupManager->get($groupId);
 		if ($group !== null) {
-			$isSubadminOfGroup =$this->groupManager->getSubAdmin()->isSubAdminofGroup($user, $group);
+			$isSubadminOfGroup = $this->groupManager->getSubAdmin()->isSubAdminofGroup($user, $group);
 		}
 
 		// 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);
@@ -172,12 +172,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('', 102);
 		}
 		$this->groupManager->createGroup($groupid);
@@ -193,9 +193,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);
 		}
@@ -211,7 +211,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);
 		}
 

apps/provisioning_api/appinfo/routes.php

Indentation +38 added lines, -38 removed lines

@@ -25,45 +25,45 @@
  */
 
 return [
-	'ocs' => [
-		// Apps
-		['root' => '/cloud', 'name' => 'Apps#getApps', 'url' => '/apps', 'verb' => 'GET'],
-		['root' => '/cloud', 'name' => 'Apps#getAppInfo', 'url' => '/apps/{app}', 'verb' => 'GET'],
-		['root' => '/cloud', 'name' => 'Apps#enable', 'url' => '/apps/{app}', 'verb' => 'POST'],
-		['root' => '/cloud', 'name' => 'Apps#disable', 'url' => '/apps/{app}', 'verb' => 'DELETE'],
+    'ocs' => [
+        // Apps
+        ['root' => '/cloud', 'name' => 'Apps#getApps', 'url' => '/apps', 'verb' => 'GET'],
+        ['root' => '/cloud', 'name' => 'Apps#getAppInfo', 'url' => '/apps/{app}', 'verb' => 'GET'],
+        ['root' => '/cloud', 'name' => 'Apps#enable', 'url' => '/apps/{app}', 'verb' => 'POST'],
+        ['root' => '/cloud', 'name' => 'Apps#disable', 'url' => '/apps/{app}', 'verb' => 'DELETE'],
 
-		// Groups
-		['root' => '/cloud', 'name' => 'Groups#getGroups', 'url' => '/groups', 'verb' => 'GET'],
-		['root' => '/cloud', 'name' => 'Groups#getGroupsDetails', 'url' => '/groups/details', 'verb' => 'GET'],
-		['root' => '/cloud', 'name' => 'Groups#getGroup', 'url' => '/groups/{groupId}', 'verb' => 'GET'],
-		['root' => '/cloud', 'name' => 'Groups#addGroup', 'url' => '/groups', 'verb' => 'POST'],
-		['root' => '/cloud', 'name' => 'Groups#deleteGroup', 'url' => '/groups/{groupId}', 'verb' => 'DELETE'],
-		['root' => '/cloud', 'name' => 'Groups#getSubAdminsOfGroup', 'url' => '/groups/{groupId}/subadmins', 'verb' => 'GET'],
+        // Groups
+        ['root' => '/cloud', 'name' => 'Groups#getGroups', 'url' => '/groups', 'verb' => 'GET'],
+        ['root' => '/cloud', 'name' => 'Groups#getGroupsDetails', 'url' => '/groups/details', 'verb' => 'GET'],
+        ['root' => '/cloud', 'name' => 'Groups#getGroup', 'url' => '/groups/{groupId}', 'verb' => 'GET'],
+        ['root' => '/cloud', 'name' => 'Groups#addGroup', 'url' => '/groups', 'verb' => 'POST'],
+        ['root' => '/cloud', 'name' => 'Groups#deleteGroup', 'url' => '/groups/{groupId}', 'verb' => 'DELETE'],
+        ['root' => '/cloud', 'name' => 'Groups#getSubAdminsOfGroup', 'url' => '/groups/{groupId}/subadmins', 'verb' => 'GET'],
 
-		// Users
-		['root' => '/cloud', 'name' => 'Users#getUsers', 'url' => '/users', 'verb' => 'GET'],
-		['root' => '/cloud', 'name' => 'Users#getUsersDetails', 'url' => '/users/details', 'verb' => 'GET'],
-		['root' => '/cloud', 'name' => 'Users#addUser', 'url' => '/users', 'verb' => 'POST'],
-		['root' => '/cloud', 'name' => 'Users#getUser', 'url' => '/users/{userId}', 'verb' => 'GET'],
-		['root' => '/cloud', 'name' => 'Users#getCurrentUser', 'url' => '/user', 'verb' => 'GET'],
-		['root' => '/cloud', 'name' => 'Users#getEditableFields', 'url' => '/user/fields', 'verb' => 'GET'],
-		['root' => '/cloud', 'name' => 'Users#editUser', 'url' => '/users/{userId}', 'verb' => 'PUT'],
-		['root' => '/cloud', 'name' => 'Users#deleteUser', 'url' => '/users/{userId}', 'verb' => 'DELETE'],
-		['root' => '/cloud', 'name' => 'Users#enableUser', 'url' => '/users/{userId}/enable', 'verb' => 'PUT'],
-		['root' => '/cloud', 'name' => 'Users#disableUser', 'url' => '/users/{userId}/disable', 'verb' => 'PUT'],
-		['root' => '/cloud', 'name' => 'Users#getUsersGroups', 'url' => '/users/{userId}/groups', 'verb' => 'GET'],
-		['root' => '/cloud', 'name' => 'Users#addToGroup', 'url' => '/users/{userId}/groups', 'verb' => 'POST'],
-		['root' => '/cloud', 'name' => 'Users#removeFromGroup', 'url' => '/users/{userId}/groups', 'verb' => 'DELETE'],
-		['root' => '/cloud', 'name' => 'Users#getUserSubAdminGroups', 'url' => '/users/{userId}/subadmins', 'verb' => 'GET'],
-		['root' => '/cloud', 'name' => 'Users#addSubAdmin', 'url' => '/users/{userId}/subadmins', 'verb' => 'POST'],
-		['root' => '/cloud', 'name' => 'Users#removeSubAdmin', 'url' => '/users/{userId}/subadmins', 'verb' => 'DELETE'],
-		['root' => '/cloud', 'name' => 'Users#resendWelcomeMessage', 'url' => '/users/{userId}/welcome', 'verb' => 'POST'],
+        // Users
+        ['root' => '/cloud', 'name' => 'Users#getUsers', 'url' => '/users', 'verb' => 'GET'],
+        ['root' => '/cloud', 'name' => 'Users#getUsersDetails', 'url' => '/users/details', 'verb' => 'GET'],
+        ['root' => '/cloud', 'name' => 'Users#addUser', 'url' => '/users', 'verb' => 'POST'],
+        ['root' => '/cloud', 'name' => 'Users#getUser', 'url' => '/users/{userId}', 'verb' => 'GET'],
+        ['root' => '/cloud', 'name' => 'Users#getCurrentUser', 'url' => '/user', 'verb' => 'GET'],
+        ['root' => '/cloud', 'name' => 'Users#getEditableFields', 'url' => '/user/fields', 'verb' => 'GET'],
+        ['root' => '/cloud', 'name' => 'Users#editUser', 'url' => '/users/{userId}', 'verb' => 'PUT'],
+        ['root' => '/cloud', 'name' => 'Users#deleteUser', 'url' => '/users/{userId}', 'verb' => 'DELETE'],
+        ['root' => '/cloud', 'name' => 'Users#enableUser', 'url' => '/users/{userId}/enable', 'verb' => 'PUT'],
+        ['root' => '/cloud', 'name' => 'Users#disableUser', 'url' => '/users/{userId}/disable', 'verb' => 'PUT'],
+        ['root' => '/cloud', 'name' => 'Users#getUsersGroups', 'url' => '/users/{userId}/groups', 'verb' => 'GET'],
+        ['root' => '/cloud', 'name' => 'Users#addToGroup', 'url' => '/users/{userId}/groups', 'verb' => 'POST'],
+        ['root' => '/cloud', 'name' => 'Users#removeFromGroup', 'url' => '/users/{userId}/groups', 'verb' => 'DELETE'],
+        ['root' => '/cloud', 'name' => 'Users#getUserSubAdminGroups', 'url' => '/users/{userId}/subadmins', 'verb' => 'GET'],
+        ['root' => '/cloud', 'name' => 'Users#addSubAdmin', 'url' => '/users/{userId}/subadmins', 'verb' => 'POST'],
+        ['root' => '/cloud', 'name' => 'Users#removeSubAdmin', 'url' => '/users/{userId}/subadmins', 'verb' => 'DELETE'],
+        ['root' => '/cloud', 'name' => 'Users#resendWelcomeMessage', 'url' => '/users/{userId}/welcome', 'verb' => 'POST'],
 
-		// Config
-		['name' => 'AppConfig#getApps', 'url' => '/api/v1/config/apps', 'verb' => 'GET'],
-		['name' => 'AppConfig#getKeys', 'url' => '/api/v1/config/apps/{app}', 'verb' => 'GET'],
-		['name' => 'AppConfig#getValue', 'url' => '/api/v1/config/apps/{app}/{key}', 'verb' => 'GET'],
-		['name' => 'AppConfig#setValue', 'url' => '/api/v1/config/apps/{app}/{key}', 'verb' => 'POST'],
-		['name' => 'AppConfig#deleteKey', 'url' => '/api/v1/config/apps/{app}/{key}', 'verb' => 'DELETE'],
-	],
+        // Config
+        ['name' => 'AppConfig#getApps', 'url' => '/api/v1/config/apps', 'verb' => 'GET'],
+        ['name' => 'AppConfig#getKeys', 'url' => '/api/v1/config/apps/{app}', 'verb' => 'GET'],
+        ['name' => 'AppConfig#getValue', 'url' => '/api/v1/config/apps/{app}/{key}', 'verb' => 'GET'],
+        ['name' => 'AppConfig#setValue', 'url' => '/api/v1/config/apps/{app}/{key}', 'verb' => 'POST'],
+        ['name' => 'AppConfig#deleteKey', 'url' => '/api/v1/config/apps/{app}/{key}', 'verb' => 'DELETE'],
+    ],
 ];