nextcloud / server

lib/private/Group/Manager.php

Indentation +344 added lines, -344 removed lines

@@ -61,348 +61,348 @@
  * @package OC\Group
  */
 class Manager extends PublicEmitter implements IGroupManager {
-	/**
-	 * @var GroupInterface[] $backends
-	 */
-	private $backends = array();
-
-	/**
-	 * @var \OC\User\Manager $userManager
-	 */
-	private $userManager;
-
-	/**
-	 * @var \OC\Group\Group[]
-	 */
-	private $cachedGroups = array();
-
-	/**
-	 * @var \OC\Group\Group[]
-	 */
-	private $cachedUserGroups = array();
-
-	/** @var \OC\SubAdmin */
-	private $subAdmin = null;
-
-	/** @var ILogger */
-	private $logger;
-
-	/**
-	 * @param \OC\User\Manager $userManager
-	 * @param ILogger $logger
-	 */
-	public function __construct(\OC\User\Manager $userManager, ILogger $logger) {
-		$this->userManager = $userManager;
-		$this->logger = $logger;
-		$cachedGroups = & $this->cachedGroups;
-		$cachedUserGroups = & $this->cachedUserGroups;
-		$this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
-			/**
-			 * @var \OC\Group\Group $group
-			 */
-			unset($cachedGroups[$group->getGID()]);
-			$cachedUserGroups = array();
-		});
-		$this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
-			/**
-			 * @var \OC\Group\Group $group
-			 */
-			$cachedUserGroups = array();
-		});
-		$this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
-			/**
-			 * @var \OC\Group\Group $group
-			 */
-			$cachedUserGroups = array();
-		});
-	}
-
-	/**
-	 * Checks whether a given backend is used
-	 *
-	 * @param string $backendClass Full classname including complete namespace
-	 * @return bool
-	 */
-	public function isBackendUsed($backendClass) {
-		$backendClass = strtolower(ltrim($backendClass, '\\'));
-
-		foreach ($this->backends as $backend) {
-			if (strtolower(get_class($backend)) === $backendClass) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * @param \OCP\GroupInterface $backend
-	 */
-	public function addBackend($backend) {
-		$this->backends[] = $backend;
-		$this->clearCaches();
-	}
-
-	public function clearBackends() {
-		$this->backends = array();
-		$this->clearCaches();
-	}
-
-	/**
-	 * Get the active backends
-	 * @return \OCP\GroupInterface[]
-	 */
-	public function getBackends() {
-		return $this->backends;
-	}
-
-
-	protected function clearCaches() {
-		$this->cachedGroups = array();
-		$this->cachedUserGroups = array();
-	}
-
-	/**
-	 * @param string $gid
-	 * @return \OC\Group\Group
-	 */
-	public function get($gid) {
-		if (isset($this->cachedGroups[$gid])) {
-			return $this->cachedGroups[$gid];
-		}
-		return $this->getGroupObject($gid);
-	}
-
-	/**
-	 * @param string $gid
-	 * @param string $displayName
-	 * @return \OCP\IGroup
-	 */
-	protected function getGroupObject($gid, $displayName = null) {
-		$backends = array();
-		foreach ($this->backends as $backend) {
-			if ($backend->implementsActions(\OC\Group\Backend::GROUP_DETAILS)) {
-				$groupData = $backend->getGroupDetails($gid);
-				if (is_array($groupData) && !empty($groupData)) {
-					// take the display name from the first backend that has a non-null one
-					if (is_null($displayName) && isset($groupData['displayName'])) {
-						$displayName = $groupData['displayName'];
-					}
-					$backends[] = $backend;
-				}
-			} else if ($backend->groupExists($gid)) {
-				$backends[] = $backend;
-			}
-		}
-		if (count($backends) === 0) {
-			return null;
-		}
-		$this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this, $displayName);
-		return $this->cachedGroups[$gid];
-	}
-
-	/**
-	 * @param string $gid
-	 * @return bool
-	 */
-	public function groupExists($gid) {
-		return $this->get($gid) instanceof IGroup;
-	}
-
-	/**
-	 * @param string $gid
-	 * @return \OC\Group\Group
-	 */
-	public function createGroup($gid) {
-		if ($gid === '' || $gid === null) {
-			return false;
-		} else if ($group = $this->get($gid)) {
-			return $group;
-		} else {
-			$this->emit('\OC\Group', 'preCreate', array($gid));
-			foreach ($this->backends as $backend) {
-				if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) {
-					$backend->createGroup($gid);
-					$group = $this->getGroupObject($gid);
-					$this->emit('\OC\Group', 'postCreate', array($group));
-					return $group;
-				}
-			}
-			return null;
-		}
-	}
-
-	/**
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \OC\Group\Group[]
-	 */
-	public function search($search, $limit = null, $offset = null) {
-		$groups = array();
-		foreach ($this->backends as $backend) {
-			$groupIds = $backend->getGroups($search, $limit, $offset);
-			foreach ($groupIds as $groupId) {
-				$aGroup = $this->get($groupId);
-				if ($aGroup instanceof IGroup) {
-					$groups[$groupId] = $aGroup;
-				} else {
-					$this->logger->debug('Group "' . $groupId . '" was returned by search but not found through direct access', ['app' => 'core']);
-				}
-			}
-			if (!is_null($limit) and $limit <= 0) {
-				return array_values($groups);
-			}
-		}
-		return array_values($groups);
-	}
-
-	/**
-	 * @param IUser|null $user
-	 * @return \OC\Group\Group[]
-	 */
-	public function getUserGroups(IUser $user= null) {
-		if (!$user instanceof IUser) {
-			return [];
-		}
-		return $this->getUserIdGroups($user->getUID());
-	}
-
-	/**
-	 * @param string $uid the user id
-	 * @return \OC\Group\Group[]
-	 */
-	public function getUserIdGroups($uid) {
-		if (isset($this->cachedUserGroups[$uid])) {
-			return $this->cachedUserGroups[$uid];
-		}
-		$groups = array();
-		foreach ($this->backends as $backend) {
-			$groupIds = $backend->getUserGroups($uid);
-			if (is_array($groupIds)) {
-				foreach ($groupIds as $groupId) {
-					$aGroup = $this->get($groupId);
-					if ($aGroup instanceof IGroup) {
-						$groups[$groupId] = $aGroup;
-					} else {
-						$this->logger->debug('User "' . $uid . '" belongs to deleted group: "' . $groupId . '"', ['app' => 'core']);
-					}
-				}
-			}
-		}
-		$this->cachedUserGroups[$uid] = $groups;
-		return $this->cachedUserGroups[$uid];
-	}
-
-	/**
-	 * Checks if a userId is in the admin group
-	 * @param string $userId
-	 * @return bool if admin
-	 */
-	public function isAdmin($userId) {
-		foreach ($this->backends as $backend) {
-			if ($backend->implementsActions(\OC\Group\Backend::IS_ADMIN) && $backend->isAdmin($userId)) {
-				return true;
-			}
-		}
-		return $this->isInGroup($userId, 'admin');
-	}
-
-	/**
-	 * Checks if a userId is in a group
-	 * @param string $userId
-	 * @param string $group
-	 * @return bool if in group
-	 */
-	public function isInGroup($userId, $group) {
-		return array_key_exists($group, $this->getUserIdGroups($userId));
-	}
-
-	/**
-	 * get a list of group ids for a user
-	 * @param IUser $user
-	 * @return array with group ids
-	 */
-	public function getUserGroupIds(IUser $user) {
-		return array_map(function($value) {
-			return (string) $value;
-		}, array_keys($this->getUserGroups($user)));
-	}
-
-	/**
-	 * get an array of groupid and displayName for a user
-	 * @param IUser $user
-	 * @return array ['displayName' => displayname]
-	 */
-	public function getUserGroupNames(IUser $user) {
-		return array_map(function($group) {
-			return array('displayName' => $group->getDisplayName());
-		}, $this->getUserGroups($user));
-	}
-
-	/**
-	 * get a list of all display names in a group
-	 * @param string $gid
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array an array of display names (value) and user ids (key)
-	 */
-	public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
-		$group = $this->get($gid);
-		if(is_null($group)) {
-			return array();
-		}
-
-		$search = trim($search);
-		$groupUsers = array();
-
-		if(!empty($search)) {
-			// only user backends have the capability to do a complex search for users
-			$searchOffset = 0;
-			$searchLimit = $limit * 100;
-			if($limit === -1) {
-				$searchLimit = 500;
-			}
-
-			do {
-				$filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset);
-				foreach($filteredUsers as $filteredUser) {
-					if($group->inGroup($filteredUser)) {
-						$groupUsers[]= $filteredUser;
-					}
-				}
-				$searchOffset += $searchLimit;
-			} while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit);
-
-			if($limit === -1) {
-				$groupUsers = array_slice($groupUsers, $offset);
-			} else {
-				$groupUsers = array_slice($groupUsers, $offset, $limit);
-			}
-		} else {
-			$groupUsers = $group->searchUsers('', $limit, $offset);
-		}
-
-		$matchingUsers = array();
-		foreach($groupUsers as $groupUser) {
-			$matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName();
-		}
-		return $matchingUsers;
-	}
-
-	/**
-	 * @return \OC\SubAdmin
-	 */
-	public function getSubAdmin() {
-		if (!$this->subAdmin) {
-			$this->subAdmin = new \OC\SubAdmin(
-				$this->userManager,
-				$this,
-				\OC::$server->getDatabaseConnection()
-			);
-		}
-
-		return $this->subAdmin;
-	}
+    /**
+     * @var GroupInterface[] $backends
+     */
+    private $backends = array();
+
+    /**
+     * @var \OC\User\Manager $userManager
+     */
+    private $userManager;
+
+    /**
+     * @var \OC\Group\Group[]
+     */
+    private $cachedGroups = array();
+
+    /**
+     * @var \OC\Group\Group[]
+     */
+    private $cachedUserGroups = array();
+
+    /** @var \OC\SubAdmin */
+    private $subAdmin = null;
+
+    /** @var ILogger */
+    private $logger;
+
+    /**
+     * @param \OC\User\Manager $userManager
+     * @param ILogger $logger
+     */
+    public function __construct(\OC\User\Manager $userManager, ILogger $logger) {
+        $this->userManager = $userManager;
+        $this->logger = $logger;
+        $cachedGroups = & $this->cachedGroups;
+        $cachedUserGroups = & $this->cachedUserGroups;
+        $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
+            /**
+             * @var \OC\Group\Group $group
+             */
+            unset($cachedGroups[$group->getGID()]);
+            $cachedUserGroups = array();
+        });
+        $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
+            /**
+             * @var \OC\Group\Group $group
+             */
+            $cachedUserGroups = array();
+        });
+        $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
+            /**
+             * @var \OC\Group\Group $group
+             */
+            $cachedUserGroups = array();
+        });
+    }
+
+    /**
+     * Checks whether a given backend is used
+     *
+     * @param string $backendClass Full classname including complete namespace
+     * @return bool
+     */
+    public function isBackendUsed($backendClass) {
+        $backendClass = strtolower(ltrim($backendClass, '\\'));
+
+        foreach ($this->backends as $backend) {
+            if (strtolower(get_class($backend)) === $backendClass) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * @param \OCP\GroupInterface $backend
+     */
+    public function addBackend($backend) {
+        $this->backends[] = $backend;
+        $this->clearCaches();
+    }
+
+    public function clearBackends() {
+        $this->backends = array();
+        $this->clearCaches();
+    }
+
+    /**
+     * Get the active backends
+     * @return \OCP\GroupInterface[]
+     */
+    public function getBackends() {
+        return $this->backends;
+    }
+
+
+    protected function clearCaches() {
+        $this->cachedGroups = array();
+        $this->cachedUserGroups = array();
+    }
+
+    /**
+     * @param string $gid
+     * @return \OC\Group\Group
+     */
+    public function get($gid) {
+        if (isset($this->cachedGroups[$gid])) {
+            return $this->cachedGroups[$gid];
+        }
+        return $this->getGroupObject($gid);
+    }
+
+    /**
+     * @param string $gid
+     * @param string $displayName
+     * @return \OCP\IGroup
+     */
+    protected function getGroupObject($gid, $displayName = null) {
+        $backends = array();
+        foreach ($this->backends as $backend) {
+            if ($backend->implementsActions(\OC\Group\Backend::GROUP_DETAILS)) {
+                $groupData = $backend->getGroupDetails($gid);
+                if (is_array($groupData) && !empty($groupData)) {
+                    // take the display name from the first backend that has a non-null one
+                    if (is_null($displayName) && isset($groupData['displayName'])) {
+                        $displayName = $groupData['displayName'];
+                    }
+                    $backends[] = $backend;
+                }
+            } else if ($backend->groupExists($gid)) {
+                $backends[] = $backend;
+            }
+        }
+        if (count($backends) === 0) {
+            return null;
+        }
+        $this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this, $displayName);
+        return $this->cachedGroups[$gid];
+    }
+
+    /**
+     * @param string $gid
+     * @return bool
+     */
+    public function groupExists($gid) {
+        return $this->get($gid) instanceof IGroup;
+    }
+
+    /**
+     * @param string $gid
+     * @return \OC\Group\Group
+     */
+    public function createGroup($gid) {
+        if ($gid === '' || $gid === null) {
+            return false;
+        } else if ($group = $this->get($gid)) {
+            return $group;
+        } else {
+            $this->emit('\OC\Group', 'preCreate', array($gid));
+            foreach ($this->backends as $backend) {
+                if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) {
+                    $backend->createGroup($gid);
+                    $group = $this->getGroupObject($gid);
+                    $this->emit('\OC\Group', 'postCreate', array($group));
+                    return $group;
+                }
+            }
+            return null;
+        }
+    }
+
+    /**
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return \OC\Group\Group[]
+     */
+    public function search($search, $limit = null, $offset = null) {
+        $groups = array();
+        foreach ($this->backends as $backend) {
+            $groupIds = $backend->getGroups($search, $limit, $offset);
+            foreach ($groupIds as $groupId) {
+                $aGroup = $this->get($groupId);
+                if ($aGroup instanceof IGroup) {
+                    $groups[$groupId] = $aGroup;
+                } else {
+                    $this->logger->debug('Group "' . $groupId . '" was returned by search but not found through direct access', ['app' => 'core']);
+                }
+            }
+            if (!is_null($limit) and $limit <= 0) {
+                return array_values($groups);
+            }
+        }
+        return array_values($groups);
+    }
+
+    /**
+     * @param IUser|null $user
+     * @return \OC\Group\Group[]
+     */
+    public function getUserGroups(IUser $user= null) {
+        if (!$user instanceof IUser) {
+            return [];
+        }
+        return $this->getUserIdGroups($user->getUID());
+    }
+
+    /**
+     * @param string $uid the user id
+     * @return \OC\Group\Group[]
+     */
+    public function getUserIdGroups($uid) {
+        if (isset($this->cachedUserGroups[$uid])) {
+            return $this->cachedUserGroups[$uid];
+        }
+        $groups = array();
+        foreach ($this->backends as $backend) {
+            $groupIds = $backend->getUserGroups($uid);
+            if (is_array($groupIds)) {
+                foreach ($groupIds as $groupId) {
+                    $aGroup = $this->get($groupId);
+                    if ($aGroup instanceof IGroup) {
+                        $groups[$groupId] = $aGroup;
+                    } else {
+                        $this->logger->debug('User "' . $uid . '" belongs to deleted group: "' . $groupId . '"', ['app' => 'core']);
+                    }
+                }
+            }
+        }
+        $this->cachedUserGroups[$uid] = $groups;
+        return $this->cachedUserGroups[$uid];
+    }
+
+    /**
+     * Checks if a userId is in the admin group
+     * @param string $userId
+     * @return bool if admin
+     */
+    public function isAdmin($userId) {
+        foreach ($this->backends as $backend) {
+            if ($backend->implementsActions(\OC\Group\Backend::IS_ADMIN) && $backend->isAdmin($userId)) {
+                return true;
+            }
+        }
+        return $this->isInGroup($userId, 'admin');
+    }
+
+    /**
+     * Checks if a userId is in a group
+     * @param string $userId
+     * @param string $group
+     * @return bool if in group
+     */
+    public function isInGroup($userId, $group) {
+        return array_key_exists($group, $this->getUserIdGroups($userId));
+    }
+
+    /**
+     * get a list of group ids for a user
+     * @param IUser $user
+     * @return array with group ids
+     */
+    public function getUserGroupIds(IUser $user) {
+        return array_map(function($value) {
+            return (string) $value;
+        }, array_keys($this->getUserGroups($user)));
+    }
+
+    /**
+     * get an array of groupid and displayName for a user
+     * @param IUser $user
+     * @return array ['displayName' => displayname]
+     */
+    public function getUserGroupNames(IUser $user) {
+        return array_map(function($group) {
+            return array('displayName' => $group->getDisplayName());
+        }, $this->getUserGroups($user));
+    }
+
+    /**
+     * get a list of all display names in a group
+     * @param string $gid
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array an array of display names (value) and user ids (key)
+     */
+    public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
+        $group = $this->get($gid);
+        if(is_null($group)) {
+            return array();
+        }
+
+        $search = trim($search);
+        $groupUsers = array();
+
+        if(!empty($search)) {
+            // only user backends have the capability to do a complex search for users
+            $searchOffset = 0;
+            $searchLimit = $limit * 100;
+            if($limit === -1) {
+                $searchLimit = 500;
+            }
+
+            do {
+                $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset);
+                foreach($filteredUsers as $filteredUser) {
+                    if($group->inGroup($filteredUser)) {
+                        $groupUsers[]= $filteredUser;
+                    }
+                }
+                $searchOffset += $searchLimit;
+            } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit);
+
+            if($limit === -1) {
+                $groupUsers = array_slice($groupUsers, $offset);
+            } else {
+                $groupUsers = array_slice($groupUsers, $offset, $limit);
+            }
+        } else {
+            $groupUsers = $group->searchUsers('', $limit, $offset);
+        }
+
+        $matchingUsers = array();
+        foreach($groupUsers as $groupUser) {
+            $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName();
+        }
+        return $matchingUsers;
+    }
+
+    /**
+     * @return \OC\SubAdmin
+     */
+    public function getSubAdmin() {
+        if (!$this->subAdmin) {
+            $this->subAdmin = new \OC\SubAdmin(
+                $this->userManager,
+                $this,
+                \OC::$server->getDatabaseConnection()
+            );
+        }
+
+        return $this->subAdmin;
+    }
 }