allow multiply group backends

1 files changed, 51 insertions, 68 deletions

diff --git a/lib/group/backend.php b/lib/group/backend.php
index 43f94e7ea1a..b3fc06ac9a8 100644
--- a/lib/group/backend.php
+++ b/lib/group/backend.php
@@ -21,82 +21,65 @@
 *
 */
 
+/**
+ * error code for functions not provided by the group backend
+ */
+define('OC_GROUP_BACKEND_NOT_IMPLEMENTED',   -501);
 
+/**
+ * actions that user backends can define
+ */
+define('OC_GROUP_BACKEND_CREATE_GROUP',      0x00000001);
+define('OC_GROUP_BACKEND_DELETE_GROUP',      0x00000010);
+define('OC_GROUP_BACKEND_IN_GROUP',          0x00000100);
+define('OC_GROUP_BACKEND_ADD_TO_GROUP',      0x00001000);
+define('OC_GROUP_BACKEND_REMOVE_FROM_GOUP',  0x00010000);
+define('OC_GROUP_BACKEND_GET_USER_GROUPS',   0x00100000);
+define('OC_GROUP_BACKEND_GET_USERS',         0x01000000);
+define('OC_GROUP_BACKEND_GET_GROUPS',        0x10000000);
 
 /**
  * Abstract base class for user management
  */
 abstract class OC_Group_Backend {
+	protected $possibleActions = array(
+		OC_GROUP_BACKEND_CREATE_GROUP => 'createGroup',
+		OC_GROUP_BACKEND_DELETE_GROUP => 'deleteGroup',
+		OC_GROUP_BACKEND_IN_GROUP => 'inGroup',
+		OC_GROUP_BACKEND_ADD_TO_GROUP => 'addToGroup',
+		OC_GROUP_BACKEND_REMOVE_FROM_GOUP => 'removeFromGroup',
+		OC_GROUP_BACKEND_GET_USER_GROUPS => 'getUserGroups',
+		OC_GROUP_BACKEND_GET_USERS => 'usersInGroup',
+		OC_GROUP_BACKEND_GET_GROUPS => 'getGroups'
+	);
+	
 	/**
-	 * @brief Try to create a new group
-	 * @param $gid The name of the group to create
-	 * @returns true/false
-	 *
-	 * Trys to create a new group. If the group name already exists, false will
-	 * be returned.
-	 */
-	public static function createGroup($gid){}
-
-	/**
-	 * @brief delete a group
-	 * @param $gid gid of the group to delete
-	 * @returns true/false
-	 *
-	 * Deletes a group and removes it from the group_user-table
-	 */
-	public static function removeGroup($gid){}
-
-	/**
-	 * @brief is user in group?
-	 * @param $uid uid of the user
-	 * @param $gid gid of the group
-	 * @returns true/false
-	 *
-	 * Checks whether the user is member of a group or not.
-	 */
-	public static function inGroup($uid, $gid){}
-
-	/**
-	 * @brief Add a user to a group
-	 * @param $uid Name of the user to add to group
-	 * @param $gid Name of the group in which add the user
-	 * @returns true/false
-	 *
-	 * Adds a user to a group.
-	 */
-	public static function addToGroup($uid, $gid){}
-
-	/**
-	 * @brief Removes a user from a group
-	 * @param $uid Name of the user to remove from group
-	 * @param $gid Name of the group from which remove the user
-	 * @returns true/false
-	 *
-	 * removes the user from a group.
-	 */
-	public static function removeFromGroup($uid,$gid){}
-
-	/**
-	 * @brief Get all groups a user belongs to
-	 * @param $uid Name of the user
-	 * @returns array with group names
-	 *
-	 * This function fetches all groups a user belongs to. It does not check
-	 * if the user exists at all.
-	 */
-	public static function getUserGroups($uid){}
+	* @brief Get all supported actions
+	* @returns bitwise-or'ed actions
+	*
+	* Returns the supported actions as int to be
+	* compared with OC_USER_BACKEND_CREATE_USER etc.
+	*/
+	public function getSupportedActions(){
+		$actions = 0;
+		foreach($this->possibleActions AS $action => $methodName){
+			if(method_exists($this, $methodName)) {
+				$actions |= $action;
+			}
+		}
 
-	/**
-	 * @brief get a list of all groups
-	 * @returns array with group names
-	 *
-	 * Returns a list with all groups
-	 */
-	public static function getGroups(){}
+		return $actions;
+	}
 	
 	/**
-	 * @brief get a list of all users in a group
-	 * @returns array with user ids
-	 */
-	public static function usersInGroup($gid){}
+	* @brief Check if backend implements actions
+	* @param $actions bitwise-or'ed actions
+	* @returns boolean
+	*
+	* Returns the supported actions as int to be
+	* compared with OC_GROUP_BACKEND_CREATE_GROUP etc.
+	*/
+	public function implementsActions($actions){
+		return (bool)($this->getSupportedActions() & $actions);
+	}
 }