allow multiply group backends

6 files changed, 407 insertions, 140 deletions

diff --git a/lib/base.php b/lib/base.php
index 15c90227fec..f3dacdc0f76 100644
--- a/lib/base.php
+++ b/lib/base.php
@@ -346,7 +346,7 @@ class OC{
 
 
 		OC_User::useBackend( OC_Config::getValue( "userbackend", "database" ));
-		OC_Group::setBackend( OC_Config::getValue( "groupbackend", "database" ));
+		OC_Group::useBackend(new OC_Group_Database());
 
 		// Set up file system unless forbidden
 		global $RUNTIME_NOSETUPFS;
diff --git a/lib/group.php b/lib/group.php
index fbff41e30e9..4ae9302f78b 100644
--- a/lib/group.php
+++ b/lib/group.php
@@ -34,57 +34,25 @@
  *   post_removeFromGroup(uid, gid)
  */
 class OC_Group {
-	// The backend used for user management
-	private static $_backend;
-
-	// Backends available (except database)
-	private static $_backends = array();
-
-	/**
-	 * @brief registers backend
-	 * @param $name name of the backend
-	 * @returns true/false
-	 *
-	 * Makes a list of backends that can be used by other modules
-	 */
-	public static function registerBackend( $name ){
-		self::$_backends[] = $name;
-		return true;
-	}
-
-	/**
-	 * @brief gets available backends
-	 * @returns array of backends
-	 *
-	 * Returns the names of all backends.
-	 */
-	public static function getBackends(){
-		return self::$_backends;
-	}
+	// The backend used for group management
+	private static $_usedBackends = array();
 
 	/**
 	 * @brief set the group backend
 	 * @param  string  $backend  The backend to use for user managment
 	 * @returns true/false
 	 */
-	public static function setBackend( $backend = 'database' ){
-		// You'll never know what happens
-		if( null === $backend OR !is_string( $backend )){
-			$backend = 'database';
+	public static function useBackend( $backend ){
+		if($backend instanceof OC_Group_Backend){
+			self::$_usedBackends[]=$backend;
 		}
+	}
 
-		// Load backend
-		switch( $backend ){
-			case 'database':
-			case 'mysql':
-			case 'sqlite':
-				self::$_backend = new OC_Group_Database();
-				break;
-			default:
-				$className = 'OC_GROUP_' . strToUpper($backend);
-				self::$_backend = new $className();
-				break;
-		}
+	/**
+	 * remove all used backends
+	 */
+	public static function clearBackends(){
+		self::$_usedBackends=array();
 	}
 
 	/**
@@ -115,11 +83,18 @@ class OC_Group {
 		$run = true;
 		OC_Hook::emit( "OC_Group", "pre_createGroup", array( "run" => &$run, "gid" => $gid ));
 
-		if( $run && self::$_backend->createGroup( $gid )){
-			OC_Hook::emit( "OC_Group", "post_createGroup", array( "gid" => $gid ));
-			return true;
-		}
-		else{
+		if($run){
+			//create the user in the first backend that supports creating users
+			foreach(self::$_usedBackends as $backend){
+				if(!$backend->implementsActions(OC_GROUP_BACKEND_CREATE_GROUP))
+					continue;
+
+				$backend->createGroup($gid);
+				OC_Hook::emit( "OC_User", "post_createGroup", array( "gid" => $gid ));
+
+				return true;
+			}
+		}else{
 			return false;
 		}
 	}
@@ -140,11 +115,18 @@ class OC_Group {
 		$run = true;
 		OC_Hook::emit( "OC_Group", "pre_deleteGroup", array( "run" => &$run, "gid" => $gid ));
 
-		if( $run && self::$_backend->deleteGroup( $gid )){
-			OC_Hook::emit( "OC_Group", "post_deleteGroup", array( "gid" => $gid ));
-			return true;
-		}
-		else{
+		if($run){
+			//delete the group from all backends
+			foreach(self::$_usedBackends as $backend){
+				if(!$backend->implementsActions(OC_GROUP_BACKEND_DELETE_GROUP))
+					continue;
+
+				$backend->deleteGroup($gid);
+				OC_Hook::emit( "OC_User", "post_deleteGroup", array( "gid" => $gid ));
+
+				return true;
+			}
+		}else{
 			return false;
 		}
 	}
@@ -158,7 +140,15 @@ class OC_Group {
 	 * Checks whether the user is member of a group or not.
 	 */
 	public static function inGroup( $uid, $gid ){
-		return self::$_backend->inGroup($uid, $gid);
+		foreach(self::$_usedBackends as $backend){
+			if(!$backend->implementsActions(OC_GROUP_BACKEND_IN_GROUP))
+				continue;
+
+			if($backend->inGroup($uid,$gid)){
+				return true;
+			}
+		}
+		return false;
 	}
 
 	/**
@@ -170,10 +160,6 @@ class OC_Group {
 	 * Adds a user to a group.
 	 */
 	public static function addToGroup( $uid, $gid ){
-		// Does the user exist?
-		if( !OC_User::userExists($uid)){
-			return false;
-		}
 		// Does the group exist?
 		if( !OC_Group::groupExists($gid)){
 			return false;
@@ -183,11 +169,19 @@ class OC_Group {
 		$run = true;
 		OC_Hook::emit( "OC_Group", "pre_addToGroup", array( "run" => &$run, "uid" => $uid, "gid" => $gid ));
 
-		if( $run && self::$_backend->addToGroup( $uid, $gid )){
-			OC_Hook::emit( "OC_Group", "post_addToGroup", array( "uid" => $uid, "gid" => $gid ));
-			return true;
-		}
-		else{
+		if($run){
+			$succes=false;
+			
+			//add the user to the all backends that have the group
+			foreach(self::$_usedBackends as $backend){
+				if(!$backend->implementsActions(OC_GROUP_BACKEND_ADD_TO_GROUP))
+					continue;
+
+				$succes|=$backend->addToGroup($uid, $gid);
+				OC_Hook::emit( "OC_User", "post_addToGroup", array( "uid" => $uid, "gid" => $gid ));
+			}
+			return $succes;
+		}else{
 			return false;
 		}
 	}
@@ -204,11 +198,17 @@ class OC_Group {
 		$run = true;
 		OC_Hook::emit( "OC_Group", "pre_removeFromGroup", array( "run" => &$run, "uid" => $uid, "gid" => $gid ));
 
-		if( $run && self::$_backend->removeFromGroup( $uid, $gid )){
-			OC_Hook::emit( "OC_Group", "post_removeFromGroup", array( "uid" => $uid, "gid" => $gid ));
+		if($run){
+			//remove the user from the all backends that have the group
+			foreach(self::$_usedBackends as $backend){
+				if(!$backend->implementsActions(OC_GROUP_BACKEND_REMOVE_FROM_GOUP))
+					continue;
+
+				$backend->removeFromGroup($uid, $gid);
+				OC_Hook::emit( "OC_User", "post_removeFromGroup", array( "uid" => $uid, "gid" => $gid ));
+			}
 			return true;
-		}
-		else{
+		}else{
 			return false;
 		}
 	}
@@ -222,7 +222,14 @@ class OC_Group {
 	 * if the user exists at all.
 	 */
 	public static function getUserGroups( $uid ){
-		return self::$_backend->getUserGroups($uid);
+		$groups=array();
+		foreach(self::$_usedBackends as $backend){
+			if(!$backend->implementsActions(OC_GROUP_BACKEND_GET_USER_GROUPS))
+				continue;
+
+			$groups=array_merge($backend->getUserGroups($uid),$groups);
+		}
+		return $groups;
 	}
 
 	/**
@@ -232,7 +239,14 @@ class OC_Group {
 	 * Returns a list with all groups
 	 */
 	public static function getGroups(){
-		return self::$_backend->getGroups();
+		$groups=array();
+		foreach(self::$_usedBackends as $backend){
+			if(!$backend->implementsActions(OC_GROUP_BACKEND_GET_GROUPS))
+				continue;
+
+			$groups=array_merge($backend->getGroups(),$groups);
+		}
+		return $groups;
 	}
 	
 	/**
@@ -249,6 +263,13 @@ class OC_Group {
 	 * @returns array with user ids
 	 */
 	public static function usersInGroup($gid){
-		return self::$_backend->usersInGroup($gid);
+		$users=array();
+		foreach(self::$_usedBackends as $backend){
+			if(!$backend->implementsActions(OC_GROUP_BACKEND_GET_USERS))
+				continue;
+
+			$users=array_merge($backend->usersInGroup($gid),$users);
+		}
+		return $users;
 	}
 }
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);
+	}
 }
diff --git a/lib/group/database.php b/lib/group/database.php
index 1afd4b5fe4c..d401acf43b3 100644
--- a/lib/group/database.php
+++ b/lib/group/database.php
@@ -117,8 +117,10 @@ class OC_Group_Database extends OC_Group_Backend {
 		if( !self::inGroup( $uid, $gid )){
 			$query = OC_DB::prepare( "INSERT INTO `*PREFIX*group_user` ( `uid`, `gid` ) VALUES( ?, ? )" );
 			$result = $query->execute( array( $uid, $gid ));
+			return true;
+		}else{
+			return false;
 		}
-		return true;
 	}
 
 	/**
diff --git a/lib/group/dummy.php b/lib/group/dummy.php
new file mode 100644
index 00000000000..5220237ecbf
--- /dev/null
+++ b/lib/group/dummy.php
@@ -0,0 +1,159 @@
+<?php
+
+/**
+* ownCloud
+*
+* @author Frank Karlitschek
+* @copyright 2010 Frank Karlitschek karlitschek@kde.org
+*
+* This library is free software; you can redistribute it and/or
+* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+* License as published by the Free Software Foundation; either
+* version 3 of the License, or any later version.
+*
+* This library is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
+*
+* You should have received a copy of the GNU Affero General Public
+* License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+*
+*/
+
+/**
+ * dummy group backend, does not keep state, only for testing use
+ */
+class OC_Group_Dummy extends OC_Group_Backend {
+	private $groups=array();
+	/**
+	 * @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 function createGroup($gid){
+		if(!isset($this->groups[$gid])){
+			$this->groups[$gid]=array();
+			return true;
+		}else{
+			return false;
+		}
+	}
+
+	/**
+	 * @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 function deleteGroup($gid){
+		if(isset($this->groups[$gid])){
+			unset($this->groups[$gid]);
+			return true;
+		}else{
+			return false;
+		}
+	}
+
+	/**
+	 * @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 function inGroup($uid, $gid){
+		if(isset($this->groups[$gid])){
+			return (array_search($uid,$this->groups[$gid])!==false);
+		}else{
+			return false;
+		}
+	}
+
+	/**
+	 * @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 function addToGroup($uid, $gid){
+		if(isset($this->groups[$gid])){
+			if(array_search($uid,$this->groups[$gid])===false){
+				$this->groups[$gid][]=$uid;
+				return true;
+			}else{
+				return false;
+			}
+		}else{
+			return false;
+		}
+	}
+
+	/**
+	 * @brief Removes a user from a group
+	 * @param $uid NameUSER 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 function removeFromGroup($uid,$gid){
+		if(isset($this->groups[$gid])){
+			if(($index=array_search($uid,$this->groups[$gid]))!==false){
+				unset($this->groups[$gid][$index]);
+			}else{
+				return false;
+			}
+		}else{
+			return false;
+		}
+	}
+
+	/**
+	 * @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 function getUserGroups($uid){
+		$groups=array();
+		foreach($this->groups as $group=>$user){
+			if($this->inGroup($uid,$group)){
+				$groups[]=$group;
+			}
+		}
+		return $groups;
+	}
+
+	/**
+	 * @brief get a list of all groups
+	 * @returns array with group names
+	 *
+	 * Returns a list with all groups
+	 */
+	public function getGroups(){
+		return array_keys($this->groups);
+	}
+
+	/**
+	 * @brief get a list of all users in a group
+	 * @returns array with user ids
+	 */
+	public function usersInGroup($gid){
+		if(isset($this->groups[$gid])){
+			return $this->groups[$gid];
+		}else{
+			return array();
+		}
+	}
+
+}
diff --git a/lib/group/example.php b/lib/group/example.php
new file mode 100644
index 00000000000..a88159f91be
--- /dev/null
+++ b/lib/group/example.php
@@ -0,0 +1,102 @@
+<?php
+
+/**
+* ownCloud
+*
+* @author Frank Karlitschek
+* @copyright 2010 Frank Karlitschek karlitschek@kde.org
+*
+* This library is free software; you can redistribute it and/or
+* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+* License as published by the Free Software Foundation; either
+* version 3 of the License, or any later version.
+*
+* This library is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
+*
+* You should have received a copy of the GNU Affero General Public
+* License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+*
+*/
+
+/**
+ * abstract reference class for group management
+ * this class should only be used as a reference for method signatures and their descriptions
+ */
+abstract class OC_Group_Example {
+	/**
+	 * @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 deleteGroup($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 NameUSER 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 a list of all groups
+	 * @returns array with group names
+	 *
+	 * Returns a list with all groups
+	 */
+	public static function getGroups(){}
+
+	/**
+	 * @brief get a list of all users in a group
+	 * @returns array with user ids
+	 */
+	public static function usersInGroup($gid){}
+
+}